Quickstart
Sign up to CEMEX Developer Center
To start using our API services, you must be registered in the developer center.
Registration is free, just click on the SIGN UP button and fill the requested fields. Once registered you will receive a welcome email to the platform.
Browse the available APIs
To browse available APIs, click on Products on the top menu.
You can use the supplied APIs to quickly construct a fully featured application.
Register an application
In order to call any API you must have a valid subscription key, that you can request by creating an application in Products tab.
This subscription key is used in identifying you and your application, so it must be sent as part of the http request header as Ocp-Apim-Subscription-Key.
Create new application
- Select the corresponding API product(s) on the section Products.
- On the bottom on the API product detail, fill the text box with a name of your desired new App.
- Accept API Terms and Conditions.
- Click on the Subscribe button.
- Your application will be created.
Getting your Subscription Key
From Subscription Management, click on your registered app to go into its detail view. You’ll see a subscription key for each of the selected (and approved) API products. As mentioned in step 3, this subscription key is a required request header parameter.
Each product has a different subscription key.
Public API products are automatically approved.
Partner and Private API products are internally approved and go through an internal approval process.
Getting your authentication tokens
(Applies only to Private APIs)
Additional to the subscription key, authorization token and JWT are required in every partner and private API request header.
These tokens are obtained by calling the authenticity service and including in the request body your CEMEX Go credentials.
The service will respond with an authorization access token and a JWT.
You can also export and review the following examples:
For more information please visit the Documentation page
Private APIs
The private APIs are the ones that need the parameter such as
Accept, Accept-Language, App-Code, Jwt and Authorization.
Public APIs
The public APIs only need the
header parameter Ocp-Apim-Subscription-Key as
authentication token.
Get request header parameter for Public APIs
Header parameter: Ocp-Apim-Subscription-Key
Value: From your dashboard, click on your registered app to go into its
detail view. You’ll see a subscription key for each of the
selected (and approved) API products.
Get request header parameter for Private APIs
Header parameter: Accept
Value: Application/json
---
Header parameter: Accept-Language
Value: A language tag (which is sometimes referred to as a "locale identifier") consists of a 2-3 letter base language tag representing the language, optionally followed by additional subtags separated by '-'. The most common extra information is the country or region variant.
Example:
en-US
---
Header parameter: App-Code
Value: App ID registered on the Developer Portal through the Dashboard, the App ID is defined on the section Create New App
Example:
TestApp
---
Header parameter: Jwt
Value: How to
---
Header parameter: Authorization
Value: Bearer + access_token.
Example:
Bearer eyJhbGciOiJIU...
How to
---
Header parameter: Ocp-Apim-Subscription-Key
Value: From your dashboard, click on your registered app to go into its detail view. You’ll see a subscription key for each of the selected (and approved) API products
Example:
9b5c500042c6497da43240...
Get JWT value
Use the following API
https://openapi.cemexgo.com/v2/secm/oam/oauth2/token
then set the following parameters and body parameters to get JWT value
Header parameter: Content-Type
Value: application/x-www-form-urlencoded
---
Body parameter: grant-type
Value: Password
---
Body parameter: scope
Value: Security
---
Body parameter: username
Value: CEMEX Username
---
Body parameter: password
Value: CEMEX Password
Get Authorization value
Header parameter: Content-Type
Value: application/x-www-form-urlencoded
---
Body parameter: grant-type
Value: Password
---
Body parameter: scope
Value: Security
---
Body parameter: username
Value: CEMEX Username
---
Body parameter: password
Value: CEMEX Password
Get CEMEX Account
Getting a CEMEX Go account is a separate process done through CEMEX Go, please find a video with instructions on how to get it.
Promoting your application to Production
On the top of the page, make sure you are on “Production Environment”
1. In order to call any API in Production, you must have a valid subscription key, that you can request by creating an application in the tab Products. To do so, select the type of API you want to create a new App.
2. On the bottom of the detail API Product you have already selected, fill the textbox with the desired name of your new App.
3. Accept API Terms and Conditions.
4. Click on the Subscribe button.
5. On the section Subscription Management under the menu Account, you will find your created app with the subscription.
