REST API

AtroCore is an API-centric application, so a frontend uses REST API to connect with a backend. Our REST API is based on OpenAPI (Swagger), so you can generate your client automatically.

All operations you perform using UI can be performed via API requests using the programing language of your choice. You can learn how API works if you trace what's going in the network tab in your browser console (press F12 key to open the console).

All requests needs to have the header: Content-Type: application/json.

The path to the API in AtroCore is: /api/v1/. Only this path can be used for your API requests.

We recommend to create a separate API user with specific rights (configure and assign a role to him) and use this user for API calls.

Video Tutorials

• How to authorize?
• How to select specific fields?
• How to filter data records?

API Documentation

REST API documentation is generated for each project automatically, based on your configurations and modules you are using.

To access it please go to https://address_of_your_atrocore/apidocs/.

For example the documentation for our public demo instance (demo.atropim.com) is available here: https://demo.atropim.com/apidocs/

1. Step: Authentication

To be able to use AtroCore API you need to go through authentication and obtain access token. Please watch the video tutorial to learn how to authorize in the REST API.

For obtaining access token you need to send GET request to /api/v1/App/user using Basic Authentication.

2. Step: Making requests

To see which requests are available read the documentation for your AtroCore instance.

To access it please go to https://address_of_your_atrocore/apidocs/.

Example of GET API request:

GET https://address_of_your_atrocore/api/v1/Product/2d643ca0gff7rh7c6

Bulk Create and Bulk Update

To do bulk create and bulk update, you can use the request

POST https://address_of_your_atrocore/api/v1/MassActions/action/upsert

The system will try to find existing entities based on the identifier or unique fields. If an entity is found, it will be updated, otherwise it will be created by the system.

Example of Payload:

[
    {
        "entity": "Product",
        "payload": {
            "name": "Apple iPhone 15",
            "sku": "iphone15"
        }
    },
    {
        "entity": "Product",
        "payload": {
            "id: "2348924928743",
            "name": "Apple iPhone 15 Pro Max",
        }
    }
]

You can see more detail about this api on https://address_of_your_atrocore/apidocs/ in section "MassActions"