{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"98a964d1-4e81-4a7c-ba1a-2e4fb7b6f899","name":"AZAPI API DOCUMENTATION","description":"### **Getting Started with AZAPI API**\n\nAZAPI offers a robust programmatic interface to facilitate seamless integration with our extensive infrastructure. Developers can harness our services effortlessly through a standardized API, leveraging their preferred programming languages. AZAPI adheres strictly to RESTful principles, employing HTTP requests and JSON responses for efficient and reliable communication.\n\n### **API Version and Security**\n\nThis documentation covers version 1 of the AZAPI API, which exclusively operates over HTTPS for enhanced security.\n\n### Optimizing Integration with Postman\n\nFor streamlined integration, we highly recommend leveraging Postman, an essential tool for executing and debugging API requests. Access our dedicated Postman collection by clicking the \"Run in Postman\" button above. This collection encompasses all documented endpoints, ensuring swift access to our comprehensive API capabilities.\n\n### Benefits of Postman\n\n**Enhanced Efficiency:** Seamlessly execute API requests within a user-friendly interface, optimizing workflow efficiency and operational speed.  \n**Effective Debugging:** Facilitate rapid troubleshooting and debugging of API calls, fostering quicker issue resolution and smoother development cycles.  \n**Comprehensive Documentation:** Postman serves as the definitive repository for our API documentation, ensuring meticulous accuracy and accessibility for developers.\n\n### Need Assistance?\n\nAt AZAPI, our engineers are readily available to assist you with any queries you may have. For prompt support, please reach out to us at [info@azapi.ai](https://mailto:info@azapi.in).\n\n> All the resources require Authentication Token. So, all requests have to be provided with a Authentication Token. \n  \n\nAZAPI client panel generates Authentication Token for Sand Box and Production environment separately for every user and client seperately.\n\n_Sample Sand Box API header details are as follows :_\n\n``` json\nAuthorization: sand-a0a2e1ff76f06b5fb164856f631e7da9fb75ffb0156e83d3928ffec64fe5463c\n\n ```\n\n_Sample Production API header details are as follows :_\n\n``` json\nAuthorization: prod-a0a2e1ff76f06b5fb164856f631e7da9fb75ffb0156e83d3928ffec64fe5463c\n\n ```\n\n### **How to Quick Start?**\n\nFor API header details (Authentication Token) for Sand Box and Production environment, please contact us at [info@azapi.ai](https://mailto:info@azapi.in)\n\n### Trial Usage\n\nExperience trial API with AZAPI, offering a daily free limit of 10 requests per API on Sand Box. Contact us at [info@azapi.ai](https://mailto:info@azapi.in) to initiate your trial today.\n\n### Endpoints\n\nThe API is accessed by making HTTP requests to a specific version endpoint URL, in which GET or POST variables contain information about what you wish to access.\n\n- Every endpoint is accessed via an SSL-enabled HTTPS.\n    \n- Everything (methods, parameters, etc.) is fixed to a version number, and every call must contain one. Different Versions are available at different endpoint URLs.\n    \n- The latest version is Version 1.\n    \n\n_The stable HTTPS endpoint for the latest version is:_\n\n``` json\nProduction URL (baseurl): https://api.azapi.ai\n\n ```\n\n### **Responses**\n\nEach response is wrapped in a data tag. This means if you have a response, it will always be within the data field. We also include a status code, success flag, type, and message in the response of each request.\n\n### **Authentication**\n\nThe API uses token-based authentication. You will be provided with a Authentication Token which must be included in the header of all requests made to the API.\n\n- All API requests must be made over HTTPS. Any requests made over HTTP will fail.\n    \n- You will be provided with both UAT and Production Authentication Token. Requests made with the Sand Box Authentication Token can be used to test our API before going live.\n    \n- Requests made in Sand Box mode will return actual responses and credits as per API will be deducted from your account.\n    \n\n### **Errors and Status Codes**\n\nStandard HTTP error codes are returned in the case of a failure:\n\n- 2xx codes indicate a successful message\n    \n- 4xx codes indicate an error caused by the information provided by the client\n    \n- 5xx codes indicate an error on AZAPI’s servers\n    \n\n### Status Code\n\n| Status Code | Name | **Description** |\n| --- | --- | --- |\n| 200 | Ok | Request Successful |\n\n### Error Code\n\n| **Error Code** | **Name** | **Description** |\n| --- | --- | --- |\n| 400 | Bad Request | A malformed request or source not available |\n| 401 | Unauthorized | Invalid authorization credentials |\n| 403 | Forbidden | Action prohibited |\n| 404 | Not Found | Resource not found |\n| 413 | Payload Too Large | The request entity is too large for the server to process |\n| 500 | Internal Server Error | An unexpected error occurred in our API |\n| 504 | Gateway Timeout | The server took too long to respond. Please try again later |\n\n### Rate Limits\n\nAZAPI’s API enforces a maximum volume of requests per minute for all clients. Unless contractually agreed otherwise, the maximum rate is 1000 requests per second.  \nAny request over the limit will return a 429 HTTP response.\n\n### Avoiding the limit\n\nThe tips below are some simple suggestions to help reduce the possibility of being rate-limited. We recommend:\n\n1. Running non-essential or routine batch API jobs outside your peak hours.\n    \n2. Throttling batch jobs.\n    \n3. Implementing an exponential back-off approach for requests essential to your verification process, with an initial delay of 30 seconds.\n    \n4. Prioritizing requests that are essential to verify an active user.\n    \n5. Setting up monitors and alerts for error responses on our API.\n    \n\n### API Deprecation\n\nWhen an API endpoint is scheduled for deprecation the following actions will be taken:\n\n1. The endpoint documentation will be marked as depreciated and a migration plan will be added.\n    \n2. The endpoint will have a Sunset header (Sunset HTTP Header) added to indicate the last date the endpoint should be relied upon.\n    \n3. An email will be sent to active third-party developers notifying them of the deprecation.  \n    An entry to the API changelog table will be added.\n    \n4. When the Sunset date has passed follow-up email will be sent to active third-party developers notifying them of the deprecation.\n    \n\n### Backward Compatibility\n\nThe following changes are considered backward compatible:\n\n1. Adding new API endpoints.\n    \n2. Adding new properties to the responses from existing API endpoints.\n    \n3. Adding optional request parameters to existing API endpoints.\n    \n4. Altering the format or length of IDs.\n    \n5. Altering the message attributes returned by validation failures or other errors.\n    \n6. Sending webhooks for new event types.\n    \n7. Reordering properties returned from existing API endpoints.\n    \n\nIf you have questions that aren't answered here, contact the Support Team: [info@azapi.ai](https://mailto:info@azapi.in)","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"32894641","team":6504808,"collectionId":"98a964d1-4e81-4a7c-ba1a-2e4fb7b6f899","publishedId":"2sAXxY59U3","public":true,"publicUrl":"https://documenter-api.postman.tech/view/32894641/2sAXxY59U3","privateUrl":"https://go.postman.co/documentation/32894641-98a964d1-4e81-4a7c-ba1a-2e4fb7b6f899","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2024-10-22T12:11:44.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/79088f88482ae65f64924a13bdbce78c15575a9b1a7b5daaa2e7684f7a6dd9b1","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2sAXxY59U3"}