Skip to content
English
Contact us
  • There are no suggestions because the search field is empty.

API Guide (Subcontractors)

Learn how to activate the 12Build API as a subcontractor, create a personal API key, and access the various features.

What will you find in this article?

  • Summary: A brief overview of the activation process for subcontractors.

  • Requirements and target audience: What needs to be arranged in advance by 12Build Support.

  • Generating an API Key: Steps to create your personal key in your account.

  • Authentication and Calling: How to use the API Key to perform actions.

Summary

Subcontractors can use the API after 12Build Support has activated the feature and a specific user. After activation, you generate an API Key yourself in your account settings, which allows you to request a temporary token for secure data exchange.

Terms and Target Audience

This article is specifically written for subcontractors who want to integrate 12Build with their own systems.

  • Activation: The API module must first be enabled by 12Build Support. To do this, send an email to support@12build.com.

  • User access: Support must designate a specific user from your contact list as the API user. All actions via the API are performed on behalf of this person.

Generate API Key

Once 12Build Support has confirmed the activation, you can generate the key.

  1. Log in to your company profile.

  2. Click on your user account in the top right corner and select My Account. 

  3. In the menu, click the API tab. 

  4. Click the button to generate an API Key. You will need this unique code for the integration. 

Authentication and Calling

The API Key forms the basis for your technical integration.

  1. Request token: Use the API Key to request a token.

  2. Validity: This token is valid for exactly one hour.

  3. Authorization: Include the token in the header for every function call as: 'X-Auth-Token: '.$token.

  4. Parameters:

    • For parameters of the 'template' type, use a GET request in the URL.

    • For parameters of the 'query' type, use a POST request.

Frequently Asked Questions (FAQ)

Question: Can I designate multiple users for the API? Answer: No, 12Build Support activates one specific user from your contacts. All API actions are logged under this user’s name.

Question: Where can I find the technical details of the functions? Answer: The complete list of functions, parameters, and responses, as well as the Postman file for testing, can be found in 12Build’s technical API documentation.

Troubleshooting

  • Symptom -> I don’t see the ‘API’ tab in my account.

    • Cause -> The API functionality has not yet been activated by 12Build Support.

    • Solution -> Send an email to support@12build.com to request activation.

  • Symptom -> My token is not accepted.

    • Cause -> The token is likely more than an hour old and has therefore expired.

    • Solution -> Request a new token using your API Key and include it in the header of your next request.