{"templateId":"openapi_docs","sharedDataIds":{"openAPIDocsStore":"oas-overview.yaml","sidebar":"sidebar-sidebar.yaml__overview"},"props":{"definitionId":"overview.yaml","dynamicMarkdocComponents":[],"baseSlug":"/overview","seo":{"title":"Aimsio API"},"itemId":"","disableAutoScroll":true,"metadata":{"type":"openapi","title":"Aimsio API","description":"## Introduction\n\nAimsio provides a set of API endpoints and supported actions to facilitate communication with external software platforms / ERPs.\n\nEach Aimsio account can access two server options: `sandbox` and `portal`\n\n* `sandbox` is the test environment we used to implement and test configuration changes for an account before live deployment.\n\n* `portal` is the live environment where accounts store their live transactions\n\n## Authentication\n\nOur API utilizes basic username and password authentication to access the API.\n\nIf you already have an Admin username set up for your account inside Aimsio, this can be used for API authentication. However, the best practice would be to set up a separate user for integration purposes and keep this set of credentials private only to the developer.\n\nAimsio users also require specific permissions to access our API. Please contact our support/integration team so they can enable the required permissions.\n\n## Throughput limitation\n\nWe currently limit API calls after calls exceed more than 10 calls per second. If our API receives too many requests (ie: if the queue takes longer than 5 seconds to return the call), the request will timeout.\n\nUp to 10 parallel calls are permitted. We do not limit the number of sequential calls. If your organization requires more headroom to complete calls to our API, please get in touch with us.\n\n## Usage - Querying data\n\nFor most entities with GET requests supported, there are two endpoints we support:\n\n* GET all objects of that type\n\n* GET one specific object based on its unique identifier (GUID/Id)\n\nWhen you send a GET all request, the system will return a JSON array, and each JSON object contains the following properties:\n\n* `dtype`: The object type\n\n* `guid/id`: Unique identifier of the object, generated by the Aimsio system\n\n* `updatedAt`: Object's last update timestamp in epoch milliseconds\n\nUsing the returned Guid or ID, you can then query each specific object from the GET single request.\n\n## Usage - Posting data\n\nTo upload data, please review the object properties and example requests for each POST endpoint.\n\nFor our `Master Data` endpoints, you can create/edit new entries into the Aimsio system.\n\nFor some other endpoints like `Invoice` or `Timecard`, we don't allow POSTing new entries, but updating status of existing entries is supported.\n\nObject types like NRBs or Crew/Equipment records are included in the `JobOrder` GET response, but have to be POSTed through their own endpoints.\n\n* Crew records: `Employee` endpoint\n\n* Equipment records: `Equipment` endpoint\n\n* NRB records: `NRB` endpoint\n"},"compilationErrors":[],"markdown":{"partials":{},"variables":{"rbac":{"teams":["anonymous"]},"user":{},"remoteAddr":{"hostname":"api.aimsio.com","port":4000,"ipAddress":"216.73.217.123"},"lang":"default_locale","env":{"PUBLIC_REDOCLY_BRANCH_NAME":"main"}}},"pagePropGetterError":{"message":"","name":""}},"slug":"/overview","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}