The Movilitas OMS API is an extension of Movilitas.Cloud that enables third-party systems to send CRPT OMS messages through Movilitas.Cloud to CRPT OMS. Movilitas.Cloud makes your system compliant with the security standards set by CRPT OMS.
- CRPT stands for Advanced Technology Development Center in Russia.
- OMS stands for Order Management Station.
The Movilitas OMS API uses the Representational State Transfer (REST) standard to interact with other systems.
Movilitas.Cloud applies a passthrough of your API request and forwards the request to CRPT OMS without changing the message. Also, Movilitas.Cloud returns the response from CRPT OMS to your system without any change.
This article describes how to send the Send Utilization Report request about the crypto codes to Movilitas.Cloud by using the Movilitas OMS 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
Make sure that:
- You have configured an MDLP (Foreign) Channel. For more information, see Configuring MDLP (Foreign) Channel.
- You have configured a CRPT OMS (Foreign) Channel. For more information, see Configuring CRPT OMS (Foreign) Channel.
- You have created an API key and generated a static authentication token. You will need the static token for each request. For more information, see Managing API Keys and Static Token.
- You have access to the CRPT OMS API specification (outside Movilitas.Cloud). As Movilitas.Cloud does not have control over the message, use it as a reference regarding the exact structure of CRPT OMS messages.
Procedure
1. Use the POST method and the following URL:
https://api.movilitas.cloud/v1/movilitas-OMS/api/v2/pharma/utilisation
2. Define the query string params by following the CRPT OMS API specification.
In our example, we are providing the OMS Identifier:
Key | Required or Optional? | Type | Action |
---|---|---|---|
omsId | Required | String | Provide the OMS Identifier. |
3. For the header, define the following:
Key | Required or Optional? | Type | Action |
---|---|---|---|
Content-Type | Required | String | Apply JSON format for the content. Use the value application/json. |
clientToken | Required | String | Provide the Movilitas.Cloud static authentication token. |
4. In the body of the request, provide the payload by following the CRPT OMS API specification.
Note: The body of the request is out of control in Movilitas.Cloud. Movilitas.Cloud applies a passthrough of your API request and forwards the request to CRPT OMS without changing the message.
5. Send the request. Movilitas.Cloud forwards your request to CRPT OMS and immediately returns the response from CRPT OMS.
Sample cURL Request
curl -X POST \ https://api.movilitas.cloud/v1/movilitas-OMS/api/v2/pharma/utilisation?omsId=CDF12109-10D3-11E6-8B6F-0050569977A1 \ -H 'Content-Type: application/json' \ -H 'clientToken: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJrZXkiOiJzX2FqazQyS2RLQWhHciE3TUZtY1Q2UzhTQ3NDQ2hzc2RoTXRFUlNBIUNwUDhlZDkzU2htQ0hoaHIyTmg3Y0dBIiwiX2lkIjoiNWQyNzA4ZDc3NDQ1OTcxYjI5MmY4ZDI3IiwiaWF0IjoxNTYzOTU3MjA4LCJleHAiOjE1NjQwNDM2MDh9.dYGzl-K1UT8jAeb-XQ0n_chI8VJzKRJiXhtnU4GenPc' \ -d '{ "sntins":[ "010460165303004621u003drxdv3Mu0\u001d91VXQI\u001d92X8s451dPdmHvUKs6cTvZgqTFvvagZl/NFVUNwo+ufaM=", "010460165303004621u003drxdv3Mu0\u001d91VXQI\u001d92A3igGog+daH9OlF2Atkb/UZvzZctL55wlOCsDXW1oyg="], "usageType":"VERIFIED", "expirationDate":"12.06.2020", "seriesNumber":"123", "subjectId":"1c858e4m-uucb-77re-1te2-ce345231ce9m", "packingId":"0c456e4a-aacb-42ae-8ef2-ce462662ce8a", "productionDate":"31.10.2019 23:59:59+03" }'
Sample Response (Success 200)
{ "omsId" : "CDF12109-10D3-11E6-8B6F-0050569977A1", "reportId" : "3179f5d2-2bf5-47d1-8df0-9452b257d851" }