{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"5e549585-0dab-4c1b-99c4-ab5c182798cf","name":"Cloverfield API","description":"This collection will allow you to connect to Cloverfield's API to upload data, get back results and more.[<img src=\"https://run.pstmn.io/button.svg\" alt=\"Run in Postman\">](https://app.getpostman.com/run-collection/28488126-90add829-4994-47de-a9ea-f480af1281c9?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D28488126-90add829-4994-47de-a9ea-f480af1281c9%26entityType%3Dcollection%26workspaceId%3Df0d7c035-c9c1-4d62-9645-c614a73631fc)\n\n# Before you start\n\nTo interact with the API, you must have a **client ID** and **client secret**.  \nIf you are a Hiphen customer and wish to use the API or forgot your credentials please [contact us](https://www.hiphen-plant.com/contact/).\n\nOnce you have your **client ID** and **client secret**, you can set the `clientId` and `clientSecret` variables either in the collection variables or in the `Hiphen Override Env` environment.  \nYou can now send requests to the API, a pre-request script will automatically generate and manage the `accessToken` variable.\n\n## Response Status Codes\n\n| **Status Code** | **Description** |\n| --- | --- |\n| 200 | `OK` |\n| 201 | `CREATED` |\n| 204 | `NO CONTENT` |\n| 400 | `BAD REQUEST` |\n| 401 | `UNAUTHORIZED` |\n| 403 | `FORBIDDEN` |\n| 404 | `NOT FOUND` |\n| 500 | `INTERNAL SERVER ERROR` |\n\n## Pagination\n\n#### Offset Pagination\n\nOffset pagination is the default pagination for endpoints returning collection of items. Offset  \npaginated endpoints accept two query params.\n\n| **Key** | **Type** | **Description** | **Default value** |\n| --- | --- | --- | --- |\n| `page[limit]` | integer | Maximum number of object returned in one  <br>request.  <br>**Note**: Each collection has an upper bound on how  <br>many items can be fetch at once. | 100 |\n| `page[offset]` | integer | Number of object skipped | 0 |\n\n#### Cursor Pagination\n\nCursor pagination is used for the get site results, get site orthoimages and get site images routes. Offset paginated endpoints accept one query param.\n\n| **Key** | **Type** | **Description** |\n| --- | --- | --- |\n| `page[next]` | string | Base64 encoded string. This string is usually provided in the  <br>previous cursor paginated call. |\n\n#### Response\n\nAll paginated response returns `data` and `meta` fields. If there is no next or previous page the field will be omitted.\n\n``` json\n// Offset pagination\n{\n    \"data\": [...],\n    \"meta\": {\n        \"links\": {\n            \"next\": \"{{url}}?page[limit]=10&page[offset]=30\",\n            \"previous\": \"{{url}}?page[limit]=10&page[offset]=10\"\n        },\n        \"size\": 10,\n        \"offset\": 20,\n        \"limit\": 10,\n        \"total\": 50\n    }\n}\n// Cursor pagination\n{\n    \"data\": [...],\n    \"meta\": {\n        \"links\": {\n            \"next\": \"{{url}}?page[next]=e2ZlYXR1cmVfaWQ6ICIyIiwgc2l0ZV9pZDogIjIiLCBpZDogIjIifQ==\"\n        },\n        \"size\": 10\n    }\n}\n\n ```","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"28488126","collectionId":"5e549585-0dab-4c1b-99c4-ab5c182798cf","publishedId":"2sA3kRKjKB","public":true,"publicUrl":"https://api-docs.hiphen-cloverfield.com","privateUrl":"https://go.postman.co/documentation/28488126-5e549585-0dab-4c1b-99c4-ab5c182798cf","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"098446"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"system_default","themes":[{"name":"dark","logo":"https://content.pstmn.io/269b3468-f6a9-4ed6-9eae-b0f8b8c11bc3/U0dsd2FHVnVYM054ZFdGeVpTNXdibWM9LnBuZw==","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"098446"}},{"name":"light","logo":"https://content.pstmn.io/269b3468-f6a9-4ed6-9eae-b0f8b8c11bc3/U0dsd2FHVnVYM054ZFdGeVpTNXdibWM9LnBuZw==","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"098446"}}]}},"version":"8.11.4","publishDate":"2024-07-17T13:05:16.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/269b3468-f6a9-4ed6-9eae-b0f8b8c11bc3/U0dsd2FHVnVYM054ZFdGeVpTNXdibWM9LnBuZw==","logoDark":"https://content.pstmn.io/269b3468-f6a9-4ed6-9eae-b0f8b8c11bc3/U0dsd2FHVnVYM054ZFdGeVpTNXdibWM9LnBuZw=="}},"statusCode":200},"environments":[{"name":"Hiphen Production","id":"a8be0309-d4bf-40be-97bc-ec6af68b3c34","owner":"28488126","values":[{"key":"clientId","value":"","enabled":true,"type":"default"},{"key":"clientSecret","value":"","enabled":true,"type":"secret"},{"key":"baseURL","value":"https://api.hiphen-cloverfield.com","enabled":true,"type":"default"},{"key":"tusdURL","value":"https://api.hiphen-cloverfield.com","enabled":true,"type":"default"}],"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/768118b36f06c94b0306958b980558e6915839447e859fe16906e29d683976f0","favicon":"https://hiphen-cloverfield.com/favicon.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":"Hiphen Production","value":"28488126-a8be0309-d4bf-40be-97bc-ec6af68b3c34"}],"canonicalUrl":"https://api-docs.hiphen-cloverfield.com/view/metadata/2sA3kRKjKB"}