Movilitas.Cloud Support

You can use the Manufacturer V2 API to integrate the shopfloor and the enterprise resource planning (ERP) systems with the Serialized Manufacturing application.

The Manufacturer V2 API uses the Representational State Transfer (REST) standard to interact with other systems.

The Manufacturer V2 API is an extension of the Serialized Manufacturing application of Movilitas.Cloud that enables you to send requests from external systems to the application.

The following figure provides an overview of all the requests that you can send by using the Manufacturer V2 API:

This article describes how to request SSCCs from the Movilitas.Cloud SSCC pool using the Manufacturer V2 API. After the request, the status of the SSCC changes from Available to Assigned, allowing you to reserve the SSCC for a task, for example, aggregation.

Note: Generating SSCCs in Movilitas.Cloud and requesting SSCCs from the Movilitas.Cloud SSCC pool are optional actions. Movilitas.Cloud enables you to use your own unique and GS1-compliant SSCCs for aggregation and it refreshes the SSCC pool with your unique SSCCs after the aggregation request is sent through Manufacturer V2 API.

API Tool to Use

In this document, we provide examples by using the cURL command-line tool. To send the API request, you can find a lot of user-friendly REST API tools on the Internet, for example, Postman.

Before You Begin

1. You must enable the Serialized Manufacturing application.

2. You must create an API key and secret. 

3. You must create a shopfloor channel with the Manufacturer V2 API source. You will need the channel key for your requests.

4. You must configure the Serialized Manufacturing application and the channels required to connect to external systems.

5. You must have the authentication token to send requests over API. Select one of the following ways:

• Apply a dynamic token. Send an authentication request over the Authentication API. For more information about the Authentication API, open the Tenant Dashboard in Movilitas.Cloud, select API keys, and choose Authentication API Documentation. Also, see Authentication Request.
• Apply a static token. Generate a static token for your previously created API key.

For more information, see Configuring the Movilitas.Cloud APIs.

Procedure

1. Use the POST method and the following URL:

https://api.movilitas.cloud/v1/manufacturer/v2/api/ssccs/request

2. For the header, define the content type (JSON), the authentication token, and the channel key.

The token can be given in one of the following ways:

• As x-access-token header.
• As Authorization header by using the Bearer schema.

Header Option 1

Header Option 2

3. In the body of the request, define the parameters and their values based on the table below.

4. Send the request.

The SSCCs will go to Assigned status that you can check under the Serialized Manufacturing application --> SN/SSCC pool --> SSCC pool tab.

Sample cURL Request

curl -X POST \
  https://api.movilitas.cloud/v1/manufacturer/v2/api/ssccs/request \
  -H 'Content-Type: application/json' \
  -H 'x-access-token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJrZXkiOiJzX2FqazQyS2RLQWhHciE3TUZtY1Q2UzhTQ3NDQ2hzc2RoTXRFUlNBIUNwUDhlZDkzU2htQ0hoaHIyTmg3Y0dBIiwiX2lkIjoiNWQyNzA4ZDc3NDQ1OTcxYjI5MmY4ZDI3IiwiaWF0IjoxNTY0MDU5ODc2LCJleHAiOjE1NjQxNDYyNzZ9.TBMv71CaxCNtE1opQMk0f1ncfbnZ0Cwnu7MWkTzkQqA' \
  -H 'x-channel-key: Ky1SpfEXmjj05fW3USBFD3pgoEi9AQ29Atsnj4Zy' \
  -d '{
    "amount": 2
}'

Sample Response (Success 200) 

{
    "success": true,
    "message": "SSCCs requested",
    "data": [
        "337370000000000003",
        "337370000000000010"
    ]
}

Error Types and Resolution

This section lists some of the most general error types when sending the request.