{"_id":"565f63c3bca87d0d006bc729","user":"55fae9d4825d5f19001fa379","version":{"_id":"55faeacad0e22017005b8268","project":"55faeacad0e22017005b8265","__v":36,"createdAt":"2015-09-17T16:31:06.800Z","releaseDate":"2015-09-17T16:31:06.800Z","categories":["55faeacbd0e22017005b8269","55faf550764f50210095078e","55faf5b5626c341700fd9e96","55faf8a7825d5f19001fa386","560052f91503430d007cc88f","560054f73aa0520d00da0b1a","56005aaf6932a00d00ba7c62","56005c273aa0520d00da0b3f","5601ae7681a9670d006d164d","5601ae926811d00d00ceb487","5601aeb064866b1900f4768d","5601aee850ee460d0002224c","5601afa02499c119000faf19","5601afd381a9670d006d1652","561d4c78281aec0d00eb27b6","561d588d8ca8b90d00210219","563a5f934cc3621900ac278c","5665c5763889610d0008a29e","566710a36819320d000c2e93","56ddf6df8a5ae10e008e3926","56e1c96b2506700e00de6e83","56e1ccc4e416450e00b9e48c","56e1ccdfe63f910e00e59870","56e1cd10bc46be0e002af26a","56e1cd21e416450e00b9e48e","56e3139a51857d0e008e77be","573b4f62ef164e2900a2b881","57c9d1335fd8ca0e006308ed","57e2bd9d1e7b7220000d7fa5","57f2b992ac30911900c7c2b6","58adb5c275df0f1b001ed59b","58c81b5c6dc7140f003c3c46","595412446ed4d9001b3e7b37","59e76ce41938310028037295","5a009de510890d001c2aabfe","5a96f89c89442e002041144b"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"v1","version_clean":"1.0.0","version":"1"},"project":"55faeacad0e22017005b8265","__v":17,"category":{"_id":"561d4c78281aec0d00eb27b6","pages":["561d4ce96386060d00e0600c","561d4d3a6386060d00e0600e","561d4d7431d9630d001eb5c5","56268a0cc2781f0d00364bba","56269097c2781f0d00364bd1","562697d0e2ce610d004e3da8","565f63c3bca87d0d006bc729","5662003255e4450d00e62c9b","566200df36398e0d00f79623","5667219ff672550d00085220","5671be061b6b730d008b4893","56cce1f7ca43550b002814d9","56d743f43513421d0093431b","56d760a6693ef41d0003abe2","56ddf7f52793543200cdc9d5","56df11f85469d02000534e56","56e1bc4c150ed52d0062c66d","56e1bd57a2494b34007f2e57","56e6daeacec7530e006a70e9","56e703e6cb97fd200068ecf2","56e82b56130a993400a647ed","56e83d108e380a2000b7ece2"],"project":"55faeacad0e22017005b8265","version":"55faeacad0e22017005b8268","__v":22,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-10-13T18:24:56.657Z","from_sync":false,"order":0,"slug":"getting-started","title":"Getting Started"},"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-12-02T21:33:55.629Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":1,"body":"DigitalGlobe's GBDX platform provides customers with a fast and easy way to search, order, and process images and their data. GBDX technical documentation will explain how to use our platform to find what you're looking for.\n\n# REST APIs and Services\n\n## Authentication\n\nAll GBDX APIs require a token. To learn how to get a token see the [Authentication Course](doc:authentication-course) \n\n ## APIs and Services\n\nOur APIs provide programmatic access to GBDX data. Our API documentation includes examples of the requests you can make to each endpoint. If you have a token, you can use the \"Try it Out\" feature to try API calls.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"API or Service\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"Catalog  V2 API\",\n    \"0-1\": \"Search  the catalog by area, date range, types, or filters. Get a record by ID.\",\n    \"1-0\": \"Orders API\",\n    \"1-1\": \"Place an order by catalog ID. Check the status of an Order.\",\n    \"2-0\": \"Workflow API\",\n    \"2-1\": \"Register a task in the workflow task registry. Submit a workflow\",\n    \"3-0\": \"S3 Storage Service\",\n    \"3-1\": \"Get temporary credentials and to access data stored in your S3 Bucket.\",\n    \"4-0\": \"Thumbnail Service\",\n    \"4-1\": \"Get thumbnails for catalog IDs by dimensions or orientation, or get its metadata.\"\n  },\n  \"cols\": 2,\n  \"rows\": 5\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"We've created a Postman collection for API calls\",\n  \"body\": \"See the Postman instructions in the Getting Started guide.\"\n}\n[/block]\n## Error and Response Codes\n\nThe GBDX platform uses conventional HTTP response codes to indicate success or failure of an API request. Codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information, and codes in the 5xx range indicate a server error.\n\n## API Updates and Breaking Change Policy\n\nWe version our APIs when breaking changes are made.  Breaking changes include:\n\n* A change in the format or schema of a response.\n* A change in response type.\n*API deletions or removals of functionality.\n\nWe consider the following changes to be non-breaking and backward-compatible, and as such they will not result in up-versioning of the API:\n\n* Adding new endpoints or HTTP methods\n* Adding new response parameters or fields\n* Adding new optional request fields\n\nIn rare cases we will need to make a breaking API change, typically in order to resolve a critical issue.  In these cases, we will make every attempt to communicate the change to all users, and give a specific time that the change will take place.​","excerpt":"Overview of DigitalGlobe's GBDX platform.","slug":"gbdx-overview-1","type":"basic","title":"GBDX Overview"}

GBDX Overview

Overview of DigitalGlobe's GBDX platform.

DigitalGlobe's GBDX platform provides customers with a fast and easy way to search, order, and process images and their data. GBDX technical documentation will explain how to use our platform to find what you're looking for. # REST APIs and Services ## Authentication All GBDX APIs require a token. To learn how to get a token see the [Authentication Course](doc:authentication-course) ## APIs and Services Our APIs provide programmatic access to GBDX data. Our API documentation includes examples of the requests you can make to each endpoint. If you have a token, you can use the "Try it Out" feature to try API calls. [block:parameters] { "data": { "h-0": "API or Service", "h-1": "Description", "0-0": "Catalog V2 API", "0-1": "Search the catalog by area, date range, types, or filters. Get a record by ID.", "1-0": "Orders API", "1-1": "Place an order by catalog ID. Check the status of an Order.", "2-0": "Workflow API", "2-1": "Register a task in the workflow task registry. Submit a workflow", "3-0": "S3 Storage Service", "3-1": "Get temporary credentials and to access data stored in your S3 Bucket.", "4-0": "Thumbnail Service", "4-1": "Get thumbnails for catalog IDs by dimensions or orientation, or get its metadata." }, "cols": 2, "rows": 5 } [/block] [block:callout] { "type": "info", "title": "We've created a Postman collection for API calls", "body": "See the Postman instructions in the Getting Started guide." } [/block] ## Error and Response Codes The GBDX platform uses conventional HTTP response codes to indicate success or failure of an API request. Codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information, and codes in the 5xx range indicate a server error. ## API Updates and Breaking Change Policy We version our APIs when breaking changes are made. Breaking changes include: * A change in the format or schema of a response. * A change in response type. *API deletions or removals of functionality. We consider the following changes to be non-breaking and backward-compatible, and as such they will not result in up-versioning of the API: * Adding new endpoints or HTTP methods * Adding new response parameters or fields * Adding new optional request fields In rare cases we will need to make a breaking API change, typically in order to resolve a critical issue. In these cases, we will make every attempt to communicate the change to all users, and give a specific time that the change will take place.​