{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"ce4e31c8-01a9-42b1-b49b-f401da1c8a46","name":"Alobees API Documentation","description":"The Alobees API is an HTTP-based API that follows the principles of [REST](https://en.wikipedia.org/wiki/Representational_state_transfer#RESTful_web_services). It leverages standard HTTP protocols, enabling easy use with simple tools like curl or more advanced platforms like Postman.\n\n## Using curl\n\nYou can test the Alobees API directly from the command line using [cURL](http://en.wikipedia.org/wiki/CURL). For example:\n\n``` shell\ncurl https://api.alobees.com/api/site -H \"Authorization: APIKey <YOUR_API_KEY>\"\n\n ```\n\n## Using Postman\n\nTo facilitate interaction with the API, Alobees provides pre-configured environments and collections for [Postman](https://www.getpostman.com).\n\n### **Benefits of Using Postman:**\n\n• Simplifies API testing with an intuitive interface.\n\n• Allows generation of code snippets in your preferred programming language.\n\nTo get started, import the provided Postman collections and environments, and configure your API Key in the environment variables.\n\n## Authentication\n\nThe API uses an **API Key** for authentication.\n\n• The API Key can be found in the Alobees account settings by the company administrator.\n\n• It must be included in the Authorization header of your HTTP requests in the following format:\n\n```\nAuthorization: APIKey <YOUR_API_KEY>\n\n ```\n\n## Limit and Pagination\n\n### **Result Limits**\n\nBy default, the API returns a maximum of **100 results** per request. You can increase this limit up to **500** by adding the limit parameter to your URL.\n\nExample:\n\n```\nhttps://api.alobees.com/api/site?limit=500\n\n ```\n\n### **Pagination**\n\nTo fetch additional results, use the skip parameter to skip a certain number of results.\n\n• To fetch results from the 101st to the 600th:\n\n```\nhttps://api.alobees.com/api/site?skip=100\n\n ```\n\n• To combine limit and skip:\n\n```\nhttps://api.alobees.com/api/sites?limit=500&skip=500\n\n ```\n\n## Sample reponse\n\nThe default response format is **JSON**. Below is a typical example:\n\n``` json\n{\n  \"data\": [\n    {\n      \"id\": \"01f5042f-c700-45ea-9c1e-32412e007aef\",\n      \"name\": \"16 18\"\n    }\n  ],\n  \"total\": 1,\n  \"type\": \"site\",\n  \"count\": 1\n}\n\n ```\n\n### **Response Fields**\n\n• data: Contains the requested data.\n\n• total: Total number of available results.\n\n• type: Type of the returned data (e.g., site).\n\n• count: Number of results in the current response.\n\n**Note**: If count is less than total, more results are available and can be fetched using pagination.\n\n## Response formats\n\nThe API supports multiple response formats:\n\n1\\. **nested** (default): Nested data structure.\n\n2\\. **normalized**: Normalized structure for use with tools like [Normalizr](https://github.com/paularmstrong/normalizr).\n\n3\\. **csv**: Comma-separated values format.\n\n### **Choosing a Format**\n\nUse the format parameter to specify the desired response format:\n\n• For a normalized response:\n\n```\nhttps://api.alobees.com/api/sites?format=normalized\n\n ```\n\n• For a csv response:\n\n```\nhttps://api.alobees.com/api/sites?format=csv\n\n ```","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"8717997","team":939857,"collectionId":"ce4e31c8-01a9-42b1-b49b-f401da1c8a46","publishedId":"UzBgtUP2","public":true,"publicUrl":"https://documenter-api.postman.tech/view/8717997/UzBgtUP2","privateUrl":"https://go.postman.co/documentation/8717997-ce4e31c8-01a9-42b1-b49b-f401da1c8a46","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"5DB8D4"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2022-06-13T09:44:36.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"Alobees PUBLIC API","id":"28d9320f-109e-436d-968d-7ade1853646f","owner":"8717997","values":[{"key":"apikey","value":"YOUR_API_KEY","enabled":true},{"key":"authorization","value":"APIKey {{apikey}}","enabled":true},{"key":"alobees","value":"https://api.alobees.com/api","enabled":true},{"key":"usertoken","value":"","enabled":true,"type":"any"}],"published":true}],"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/47bf3a44ea7a3285039be7d745ccd38ab428113c574b17d51328f4af1acbd75e","favicon":"https://res.cloudinary.com/postman/image/upload/v1587389024/team/zybsagbg6behnqjnkwpg.ico"},"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"},{"label":"Alobees PUBLIC API","value":"8717997-28d9320f-109e-436d-968d-7ade1853646f"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/UzBgtUP2"}