Mock sample for your project: Transport Department, Andhra Pradesh API
Integrate with "Transport Department, Andhra Pradesh API" from apisetu.gov.in in no time with Mockoon's ready to use mock sample
Transport Department, Andhra Pradesh
apisetu.gov.in
Version: 3.0.0
Integrate third-party APIs faster by using "Transport Department, Andhra Pradesh API" ready-to-use mock sample. Mocking this API will allow you to start working in no time. No more accounts to create, API keys to provision, accesses to configure, unplanned downtime, just work.
Improve your integration tests by mocking third-party APIs and cover more edge cases: slow response time, random failures, etc.
Description
Driving License (DL) and Vehicle Registration Certificate (RC) of the State, as available on Parivahan Sewa (http://parivahan.co.in/) of Ministry of Road Transport and Highways, are available on DigiLocker. Citizens can pull these documents into their DigiLocker accounts.
Other APIs by apisetu.gov.in
UP State Council of Vocational Training, Uttar Pradesh, Uttar Pradesh
apisetu.gov.in
The State Council for Vocational Training (SCVT), Uttar Pradesh (http://www.vppup.in/) provides semester and consolidated mark sheets as well as vocational certificates for years 2013 to 2016.
Meghalaya Board of School Education, Tura, Meghalaya
apisetu.gov.in
Meghalaya Board of School Education (MBOSE) with Marksheets of Class Xth and Class XIIth (Arts , Science, Commerce and Vocational), is availablke on DigiLocker for the students of 2015-2019.
Transport Department, Uttarakhand
apisetu.gov.in
Driving License (DL) and Vehicle Registration Certificate (RC) of the State, as available on Parivahan Sewa (http://parivahan.co.in/) of Ministry of Road Transport and Highways, are available on DigiLocker. Citizens can pull these documents into their DigiLocker accounts.
Karnataka Department of Transport, Karnataka
apisetu.gov.in
Driving License (DL) & Vehicle Registration Certificate (RC) as issued by Transport Department, Government of Karnataka (http://transport.karnataka.gov.in) can be pulled by citizens into their DigiLocker accounts.
Transport Department, Himachal Pradesh
apisetu.gov.in
Driving License (DL) and Vehicle Registration Certificate (RC) of the State, as available on Parivahan Sewa (http://parivahan.co.in/) of Ministry of Road Transport and Highways, are available on DigiLocker. Citizens can pull these documents into their DigiLocker accounts.
Transport Department, Tripura
apisetu.gov.in
Driving License (DL) and Vehicle Registration Certificate (RC) of the State, as available on Parivahan Sewa (http://parivahan.co.in/) of Ministry of Road Transport and Highways, are available on DigiLocker. Citizens can pull these documents into their DigiLocker accounts.
Department of Labour, Govt of Punjab, Punjab
apisetu.gov.in
APIs provided by Department of Labour, Govt of Punjab, Punjab.
Gujarat Vidyapith, Ahmedabad
apisetu.gov.in
Gujarat Vidyapith, Ahmedabad (http://www.gujaratvidyapith.org/) is issuing Degree certificates through DigiLocker. These can be pulled by students into their DigiLocker accounts. Currently, data for the year 2019 is made available by Gujarat Vidyapith.
Tripura State Board of Secondary Education, Tripura
apisetu.gov.in
Tripura Board of Secondary Education, (http://tbse.in) has made available Class X (2017-2019) Marksheets in DigiLocker, which can be pulled by students into their accounts.
eDistrict Chandigarh, Chandigarh
apisetu.gov.in
eDistrict Chandigarh(http://chdservices.gov.in/) is the online service delivery portal for Chandigarh Administration. Certain documents issued by it (e.g. Senior Citizen Identity Card) can be pulled into citizens' DigiLocker accounts.
Directorate of Information Technology, Government of Tripura, Tripura
apisetu.gov.in
eDistrict Tripura (http://edistrict.tripura.gov.in/) is the online service delivery portal for TripuraState Govt. Certain documents issued by it (e.g. Income, Caste Certificates etc) can be pulled into citizens' DigiLocker accounts.
Sailu Municipal Council, Maharashtra
apisetu.gov.in
APIs provided by Sailu Municipal Council, Maharashtra.
Other APIs in the same category
opendatasoft
opendatasoft.com
Benefits Intake
va.gov
The Benefits Intake API allows authorized third-party systems used by Veteran Service Organizations (VSOs), agencies, and Veterans to digitally submit VA benefits claim documents directly to the Veterans Benefits Administration's (VBA) claims intake process. This API handles documents related to the following benefit claim types:
Compensation
Pension/Survivors Benefits
Education
Fiduciary
Insurance
Veteran Readiness & Employment (VRE)
Board of Veteran Appeals (BVA)
This API also provides submission status updates until documents are successfully established for VBA claim processing, eliminating the need for users to switch between systems to manually check whether documents have been successfully uploaded.
Background
This API provides a secure, efficient, and tracked alternative to mail or fax for VA benefit claim document submissions. Documents are uploaded directly to the VBA so they can be processed as quickly as possible.
Technical overview
The Benefits Intake API first provides an upload location and unique submission identifier, and then accepts a payload consisting of a document in PDF format, zero or more optional attachments in PDF format, and some JSON metadata.
The metadata describes the document and attachments, and identifies the person for whom it is being submitted. This payload is encoded as binary multipart/form-data (not base64). The unique identifier supplied with the payload can subsequently be used to request the processing status of the uploaded document package.
To avoid errors and processing delays, API consumers are encouraged to validate the zipcode,fileNumber, veteranFirstName, veteranLastName and businessLine fields before submission according to their description in the DocumentUploadMetadata model and use the 'businessLine' attribute for the most efficient processing. Additionally, please ensure no PDF user or owner passwords are used in submitted PDFs.
Attachment & file size limits
There is no limit on the number of files a payload can contain, but size limits do apply.
Uploaded documents cannot be larger than 21" x 21"
The entire payload cannot exceed 5 GB
No single file in a payload can exceed 100 MB
Date of receipt
The date that documents are successfully submitted through the Benefits Intake API is used as the official VA date of receipt. However, note that until a document status of received, processing, success, or vbms is returned, a client cannot consider the document received by VA.
A status of received means that the document package has been transmitted, but may not be validated. Any errors with the document package, such as unreadable PDFs or a Veteran not found, will cause the status to change to error.
If the document status is error, VA has not received the submission and cannot honor the submission date as the date of receipt.
Authentication and Authorization
API requests are authorized through a symmetric API token, provided in an HTTP header with name 'apikey'. Request an API key.
Testing in the sandbox environment
In the sandbox environment, the final status of a submission is received and submissions do not actually progress to the central mail repository or VBMS.
Progress beyond the received status can be simulated for testing. We allow passing in a Status-Override header on the /uploads/{id} endpoint so that you can change the status of your submission to simulate the various scenarios.
The available statuses are pending, uploaded, received, processing, success, vbms, and error. The meaning of the various statuses is listed below in Models under DocumentUploadStatusAttributes.
Test data
We use mock test data in the sandbox environment. Data is not sent upstream and it is not necessary to align submitted test data with any other systems' data.
Upload operation
Allows a client to upload a multi-part document package (form + attachments + metadata).
Client Request: POST https://sandbox-api.va.gov/services/vba_documents/v1/
No request body or parameters required
Service Response: A JSON API object with the following attributes:
guid: An identifier used for subsequent status requests
location: A URL to which the actual document package payload can be submitted in the next step. The URL is specific to this upload request, and should not be re-used for subsequent uploads. The URL is valid for 900 seconds (15 minutes) from the time of this response. If the location is not used within 15 minutes, the GUID will expire. Once expired, status checks on the GUID will return a status of expired.
Note: If, after you've submitted a document, the status hasn't changed to uploaded before 15 minutes has elapsed, we recommend retrying the upload in order to make sure the document properly reaches our servers. If the upload continues to fail, try encoding the payload as Base64 (See below).
Client Request: PUT to the location URL returned in Step 2.
Request body should be encoded as binary multipart/form-data (base64 also available - see details below), equivalent to that generated by an HTML form submission or using “curl -F…”. The format is described in more detail below.
No apikey authorization header is required for this request, as authorization is embedded in the signed location URL.
Service Response: The HTTP status indicates whether the upload was successful.
Additionally, the response includes an ETag header containing an MD5 hash of the submitted payload. This can be compared to the submitted payload to ensure data integrity of the upload.
Status caching
Due to current system limitations, data for the /uploads/report endpoint is cached for one hour.
A request to the /uploads/{id} endpoint will return a real-time status for that GUID, and update its status in /uploads/report.
The updated_at field indicates the last time the status for a given GUID was updated.
Optional Base64 encoding
Base64 is an encoding scheme that converts binary data into text format, so that encoded textual data can be easily transported over networks uncorrupted and without data loss.
Base64 can be used to encode binary multipart/form-data it in its entirety. Note that the whole payload must be encoded, not individual parts/attachments.
After encoding your payload, you'll be required to preface your base64 string with data:multipart/form-data;base64, in order to allow our system to distinguish the file type. Your final string payload would look something like data:multipart/form-data;base64,(encryption string)== and close with the standard == marker. Note that the multipart boundaries i.e. -----WebKitFormBoundaryVfOwzCyvug0JmWYo and ending ------WebKitFormBoundaryVfOwzCyvug0JmWYo- must also be included.
Consumer onboarding process
When you're ready to move to production, request a production API key.
Compensation
Pension/Survivors Benefits
Education
Fiduciary
Insurance
Veteran Readiness & Employment (VRE)
Board of Veteran Appeals (BVA)
This API also provides submission status updates until documents are successfully established for VBA claim processing, eliminating the need for users to switch between systems to manually check whether documents have been successfully uploaded.
Background
This API provides a secure, efficient, and tracked alternative to mail or fax for VA benefit claim document submissions. Documents are uploaded directly to the VBA so they can be processed as quickly as possible.
Technical overview
The Benefits Intake API first provides an upload location and unique submission identifier, and then accepts a payload consisting of a document in PDF format, zero or more optional attachments in PDF format, and some JSON metadata.
The metadata describes the document and attachments, and identifies the person for whom it is being submitted. This payload is encoded as binary multipart/form-data (not base64). The unique identifier supplied with the payload can subsequently be used to request the processing status of the uploaded document package.
To avoid errors and processing delays, API consumers are encouraged to validate the zipcode,fileNumber, veteranFirstName, veteranLastName and businessLine fields before submission according to their description in the DocumentUploadMetadata model and use the 'businessLine' attribute for the most efficient processing. Additionally, please ensure no PDF user or owner passwords are used in submitted PDFs.
Attachment & file size limits
There is no limit on the number of files a payload can contain, but size limits do apply.
Uploaded documents cannot be larger than 21" x 21"
The entire payload cannot exceed 5 GB
No single file in a payload can exceed 100 MB
Date of receipt
The date that documents are successfully submitted through the Benefits Intake API is used as the official VA date of receipt. However, note that until a document status of received, processing, success, or vbms is returned, a client cannot consider the document received by VA.
A status of received means that the document package has been transmitted, but may not be validated. Any errors with the document package, such as unreadable PDFs or a Veteran not found, will cause the status to change to error.
If the document status is error, VA has not received the submission and cannot honor the submission date as the date of receipt.
Authentication and Authorization
API requests are authorized through a symmetric API token, provided in an HTTP header with name 'apikey'. Request an API key.
Testing in the sandbox environment
In the sandbox environment, the final status of a submission is received and submissions do not actually progress to the central mail repository or VBMS.
Progress beyond the received status can be simulated for testing. We allow passing in a Status-Override header on the /uploads/{id} endpoint so that you can change the status of your submission to simulate the various scenarios.
The available statuses are pending, uploaded, received, processing, success, vbms, and error. The meaning of the various statuses is listed below in Models under DocumentUploadStatusAttributes.
Test data
We use mock test data in the sandbox environment. Data is not sent upstream and it is not necessary to align submitted test data with any other systems' data.
Upload operation
Allows a client to upload a multi-part document package (form + attachments + metadata).
Client Request: POST https://sandbox-api.va.gov/services/vba_documents/v1/
No request body or parameters required
Service Response: A JSON API object with the following attributes:
guid: An identifier used for subsequent status requests
location: A URL to which the actual document package payload can be submitted in the next step. The URL is specific to this upload request, and should not be re-used for subsequent uploads. The URL is valid for 900 seconds (15 minutes) from the time of this response. If the location is not used within 15 minutes, the GUID will expire. Once expired, status checks on the GUID will return a status of expired.
Note: If, after you've submitted a document, the status hasn't changed to uploaded before 15 minutes has elapsed, we recommend retrying the upload in order to make sure the document properly reaches our servers. If the upload continues to fail, try encoding the payload as Base64 (See below).
Client Request: PUT to the location URL returned in Step 2.
Request body should be encoded as binary multipart/form-data (base64 also available - see details below), equivalent to that generated by an HTML form submission or using “curl -F…”. The format is described in more detail below.
No apikey authorization header is required for this request, as authorization is embedded in the signed location URL.
Service Response: The HTTP status indicates whether the upload was successful.
Additionally, the response includes an ETag header containing an MD5 hash of the submitted payload. This can be compared to the submitted payload to ensure data integrity of the upload.
Status caching
Due to current system limitations, data for the /uploads/report endpoint is cached for one hour.
A request to the /uploads/{id} endpoint will return a real-time status for that GUID, and update its status in /uploads/report.
The updated_at field indicates the last time the status for a given GUID was updated.
Optional Base64 encoding
Base64 is an encoding scheme that converts binary data into text format, so that encoded textual data can be easily transported over networks uncorrupted and without data loss.
Base64 can be used to encode binary multipart/form-data it in its entirety. Note that the whole payload must be encoded, not individual parts/attachments.
After encoding your payload, you'll be required to preface your base64 string with data:multipart/form-data;base64, in order to allow our system to distinguish the file type. Your final string payload would look something like data:multipart/form-data;base64,(encryption string)== and close with the standard == marker. Note that the multipart boundaries i.e. -----WebKitFormBoundaryVfOwzCyvug0JmWYo and ending ------WebKitFormBoundaryVfOwzCyvug0JmWYo- must also be included.
Consumer onboarding process
When you're ready to move to production, request a production API key.
Veteran Confirmation
va.gov
The Veteran Confirmation API allows you to confirm Veteran status for a given person. This can be useful for offering Veterans discounts or other benefits.
The API will only return “Confirmed” or “Not Confirmed”.
Quickstart Guide
1. Get Access Credentials
Get started by filling out the form on the Apply for VA Lighthouse Developer Access page.
After submitting a request, you will receive your credentials for using the API in the Development environment, which allows you to try it out with mock data before moving to the Production environment.
2. Test the API
In the endpoint documentation below, we've provided a curl command builder for trying out the API before implementation with your app.
Use Test User attributes to populate the request body.
3. Build your app
The base URI for the Veteran Confirmation API in the Sandbox environment is:
https://sandbox-api.va.gov/services/veteran_confirmation/v0
In this environment, use attributes from the list of Test Users. Only Test Users can return a "confirmed" response.
Check out some of our sample apps. Please visit our VA Lighthouse Support portal should you need further assistance.
4. Show us a demo and get access to the Production environment
After building your app, we ask that you give us a demo before we set you up with production credentials. Please see the Path to Production page for more details.
Authorization
This API requires an API key in combination with identifiable information for the person being confirmed listed below. API requests are authorized through a symmetric API token provided in an HTTP header with name apikey. Including more information has a better chance of making a match and returning a Confirmed status.
Required information:
First Name
Last Name
Date of Birth
Social Security Number
Optional information:
Middle Name
Gender
Reference
Sandbox vs. Production Data
APIs accessed via the Sandbox environment are using the same underlying logic as VA’s production APIs; only the underlying data store is different.
Master Veteran Index (MVI)
The Master Veteran Index confirms a user's identity. In Production, several factors are considered to confirm identity. These include: a user’s first name, last name, date of birth and Social Security number. The MVI is mocked in the Sandbox environment. In this environment, the only factor used to confirm identity is the Social Security number.
Rate Limiting
We implemented basic rate limiting of 60 requests per minute. If you exceed this quota, your request will return a 429 status code. You may petition for increased rate limits by emailing and requests will be decided on a case by case basis.
Raw Open API Spec
https://api.va.gov/services/veteran_confirmation/docs/v0/api
The API will only return “Confirmed” or “Not Confirmed”.
Quickstart Guide
1. Get Access Credentials
Get started by filling out the form on the Apply for VA Lighthouse Developer Access page.
After submitting a request, you will receive your credentials for using the API in the Development environment, which allows you to try it out with mock data before moving to the Production environment.
2. Test the API
In the endpoint documentation below, we've provided a curl command builder for trying out the API before implementation with your app.
Use Test User attributes to populate the request body.
3. Build your app
The base URI for the Veteran Confirmation API in the Sandbox environment is:
https://sandbox-api.va.gov/services/veteran_confirmation/v0
In this environment, use attributes from the list of Test Users. Only Test Users can return a "confirmed" response.
Check out some of our sample apps. Please visit our VA Lighthouse Support portal should you need further assistance.
4. Show us a demo and get access to the Production environment
After building your app, we ask that you give us a demo before we set you up with production credentials. Please see the Path to Production page for more details.
Authorization
This API requires an API key in combination with identifiable information for the person being confirmed listed below. API requests are authorized through a symmetric API token provided in an HTTP header with name apikey. Including more information has a better chance of making a match and returning a Confirmed status.
Required information:
First Name
Last Name
Date of Birth
Social Security Number
Optional information:
Middle Name
Gender
Reference
Sandbox vs. Production Data
APIs accessed via the Sandbox environment are using the same underlying logic as VA’s production APIs; only the underlying data store is different.
Master Veteran Index (MVI)
The Master Veteran Index confirms a user's identity. In Production, several factors are considered to confirm identity. These include: a user’s first name, last name, date of birth and Social Security number. The MVI is mocked in the Sandbox environment. In this environment, the only factor used to confirm identity is the Social Security number.
Rate Limiting
We implemented basic rate limiting of 60 requests per minute. If you exceed this quota, your request will return a 429 status code. You may petition for increased rate limits by emailing and requests will be decided on a case by case basis.
Raw Open API Spec
https://api.va.gov/services/veteran_confirmation/docs/v0/api
Transport Department, Haryana
apisetu.gov.in
Driving License (DL) and Vehicle Registration Certificate (RC) of the State, as available on Parivahan Sewa (http://parivahan.co.in/) of Ministry of Road Transport and Highways, are available on DigiLocker. Citizens can pull these documents into their DigiLocker accounts.
BC Geographical Names Web Service - REST API
This REST API provides searchable access to information about geographical names in the province of British Columbia, including name status and details about the corresponding geographic feature.
Please note that you may experience issues when submitting requests to the delivery or test environment if using this OpenAPI specification in other API console viewers.
Please note that you may experience issues when submitting requests to the delivery or test environment if using this OpenAPI specification in other API console viewers.
U.S. EPA Enforcement and Compliance History Online (ECHO) - Detailed Facility Report (DFR)
epa.gov
Enforcement and Compliance History Online (ECHO) is a tool developed and maintained by EPA's Office of Enforcement and Compliance Assurance for public use. ECHO provides integrated compliance and enforcement information for over 1 million regulated facilities nationwide.
DFR Rest Services provide multiple service endpoints, to retrieve detailed facility location, enforcement, compliance monitoring, and pollutant information for any single facility. See the Detailed Facility Report (DFR) Help Page (https://echo.epa.gov/help/reports/detailed-facility-report-help) for additional information on the DFR. Additionally, a Data Dictionary (https://echo.epa.gov/help/reports/dfr-data-dictionary) is also available.
There is one primary service end point, get_dfr, that provides all available DFR data. All other service end points that are exposed, will return data on a single section of the DFR.
\
Additional ECHO Resources: Web Services, About ECHO's Data, Data Downloads
DFR Rest Services provide multiple service endpoints, to retrieve detailed facility location, enforcement, compliance monitoring, and pollutant information for any single facility. See the Detailed Facility Report (DFR) Help Page (https://echo.epa.gov/help/reports/detailed-facility-report-help) for additional information on the DFR. Additionally, a Data Dictionary (https://echo.epa.gov/help/reports/dfr-data-dictionary) is also available.
There is one primary service end point, get_dfr, that provides all available DFR data. All other service end points that are exposed, will return data on a single section of the DFR.
\
Additional ECHO Resources: Web Services, About ECHO's Data, Data Downloads
Enterobase-API
warwick.ac.uk
API for EnteroBase (http://enterobase.warwick.ac.uk)
EnteroBase is a user-friendly online resource, where users can upload their
own sequencing data for de novo assembly by a stream-lined pipeline. The assemblies
are used for calling MLST and wgMLST patterns, allowing users to compare their strains
to publically available genotyping data from other EnteroBase users, GenBank and classical MLST databases.
Click here to find how to get and use an API token: http://bit.ly/1TKlaOU
EnteroBase is a user-friendly online resource, where users can upload their
own sequencing data for de novo assembly by a stream-lined pipeline. The assemblies
are used for calling MLST and wgMLST patterns, allowing users to compare their strains
to publically available genotyping data from other EnteroBase users, GenBank and classical MLST databases.
Click here to find how to get and use an API token: http://bit.ly/1TKlaOU
eNanoMapper database
AMBIT REST web services [eNanoMapper profile] with free text & faceted search
Climate FieldView Platform APIs
climate.com
Last Modified: Thu Oct 29 12:30:46 PDT 2020
All endpoints are only accessible via HTTPS.
All API endpoints are located at https://platform.climate.com (e.g.
https://platform.climate.com/v4/fields).
The authorization token endpoint is located at
https://api.climate.com/api/oauth/token.
Troubleshooting
X-Http-Request-Id response header will be returned on every call,
successful or not. If you experience an issue with our api and need
to contact technical support, please supply the value of the X-Http-Request-Id
header along with an approximate time of when the request was made.
Request Limits
When you’re onboarded to Climate’s API platform, your x-api-key is assigned a custom usage plan. Usage plans are unique to each partner and have the following key attributes:
Throttling information
burstLimit: Maximum rate limit over a period ranging from 1 second to a few seconds
rateLimit: A steady-state rate limit
Quota information
Limit: The maximum number of requests that can be made in a given month
When the request rate threshold is exceeded, a 429 response code is returned. Optionally, the Retry-After header may be returned:
Following are examples of rate limit errors:
Rate limit exceeded:
HTTP/1.1 429
Content-Type: application/json
Content-Length: 32
{"message":"Too Many Requests"}
Quota exhausted:
HTTP/1.1 429
Content-Type: application/json
Content-Length: 29
{"message":"Limit Exceeded"}
Pagination
Pagination is performed via headers. Any request which returns a "results"
array may be paginated. The following figure shows how query results are laid out with
X-Limit=4 and no filter applied.
If there are no results, a response code of 304 will be returned.
If the response is the last set of results, a response code of 200 or
206 will be returned.
If there are more results, a response code of 206 will be returned.
If X-Next-Token is provided in the request headers but the token has
expired, a response code of 409 will be returned. This is only applicable
for some endpoints; see specific endpoint documentation below.
X-Limit
The page size can be controlled with the X-Limit header. Valid values are
1-100 and defaults to 100.
X-Next-Token
If the results are paginated, a response header of X-Next-Token will be
returned. Use the associated value in the subsequent request (via the X-Next-Token
request header) to retrieve the next page. The following sequence diagram shows how to
use X-Next-Token to fetch all the records.
Chunked Uploads
Uploads larger than 5MiB (5242880 bytes) must be done in 5MiB chunks
(with the exception of the final chunk). Each chunk request MUST contain a
Content-Range header specifying the portion of the upload, and a Content-Type
header specifying binary content type (application/octet-stream). Range
uploads must be contiguous. The maximum upload size is capped at 500MiB (524288000 bytes).
Chunked Downloads
Downloads larger than 5MiB (5242880 bytes) must be done in 1-5MiB
chunks (with the exception of the final chunk, which may be less than 1MiB).
Each chunk request MUST contain a Range header specifying the requested portion of the download,
and an Accept header specifying binary and json content types (application/octet-stream,application/json)
or all content types (/).
Drivers
If you need drivers to process agronomic data, download the ADAPT plugin below. We only support the plugin in the Windows environment, minimum is Windows 7 SP1.
For asPlanted, asHarvested and asApplied data:
ADAPT Plugin
Release notes can be found here.
Download and use of the ADAPT plugin means that you agree to the EULA for use of the ADAPT plugin.
Please review the EULA (last updated on June 6th, 2019) before download and use of the ADAPT plugin.
For more information, please refer to:
ADAPT Resources
ADAPT Overview
ADAPT FAQ
ADAPT Videos
Sample Test Data
Sample agronomic data:
asPlanted and asHarvested data
asApplied data set 1
asApplied data set 2
To upload the sample data to your account, please follow the instructions in this link.
Sample soil data:
Sample soil data
All endpoints are only accessible via HTTPS.
All API endpoints are located at https://platform.climate.com (e.g.
https://platform.climate.com/v4/fields).
The authorization token endpoint is located at
https://api.climate.com/api/oauth/token.
Troubleshooting
X-Http-Request-Id response header will be returned on every call,
successful or not. If you experience an issue with our api and need
to contact technical support, please supply the value of the X-Http-Request-Id
header along with an approximate time of when the request was made.
Request Limits
When you’re onboarded to Climate’s API platform, your x-api-key is assigned a custom usage plan. Usage plans are unique to each partner and have the following key attributes:
Throttling information
burstLimit: Maximum rate limit over a period ranging from 1 second to a few seconds
rateLimit: A steady-state rate limit
Quota information
Limit: The maximum number of requests that can be made in a given month
When the request rate threshold is exceeded, a 429 response code is returned. Optionally, the Retry-After header may be returned:
Following are examples of rate limit errors:
Rate limit exceeded:
HTTP/1.1 429
Content-Type: application/json
Content-Length: 32
{"message":"Too Many Requests"}
Quota exhausted:
HTTP/1.1 429
Content-Type: application/json
Content-Length: 29
{"message":"Limit Exceeded"}
Pagination
Pagination is performed via headers. Any request which returns a "results"
array may be paginated. The following figure shows how query results are laid out with
X-Limit=4 and no filter applied.
If there are no results, a response code of 304 will be returned.
If the response is the last set of results, a response code of 200 or
206 will be returned.
If there are more results, a response code of 206 will be returned.
If X-Next-Token is provided in the request headers but the token has
expired, a response code of 409 will be returned. This is only applicable
for some endpoints; see specific endpoint documentation below.
X-Limit
The page size can be controlled with the X-Limit header. Valid values are
1-100 and defaults to 100.
X-Next-Token
If the results are paginated, a response header of X-Next-Token will be
returned. Use the associated value in the subsequent request (via the X-Next-Token
request header) to retrieve the next page. The following sequence diagram shows how to
use X-Next-Token to fetch all the records.
Chunked Uploads
Uploads larger than 5MiB (5242880 bytes) must be done in 5MiB chunks
(with the exception of the final chunk). Each chunk request MUST contain a
Content-Range header specifying the portion of the upload, and a Content-Type
header specifying binary content type (application/octet-stream). Range
uploads must be contiguous. The maximum upload size is capped at 500MiB (524288000 bytes).
Chunked Downloads
Downloads larger than 5MiB (5242880 bytes) must be done in 1-5MiB
chunks (with the exception of the final chunk, which may be less than 1MiB).
Each chunk request MUST contain a Range header specifying the requested portion of the download,
and an Accept header specifying binary and json content types (application/octet-stream,application/json)
or all content types (/).
Drivers
If you need drivers to process agronomic data, download the ADAPT plugin below. We only support the plugin in the Windows environment, minimum is Windows 7 SP1.
For asPlanted, asHarvested and asApplied data:
ADAPT Plugin
Release notes can be found here.
Download and use of the ADAPT plugin means that you agree to the EULA for use of the ADAPT plugin.
Please review the EULA (last updated on June 6th, 2019) before download and use of the ADAPT plugin.
For more information, please refer to:
ADAPT Resources
ADAPT Overview
ADAPT FAQ
ADAPT Videos
Sample Test Data
Sample agronomic data:
asPlanted and asHarvested data
asApplied data set 1
asApplied data set 2
To upload the sample data to your account, please follow the instructions in this link.
Sample soil data:
Sample soil data
Transport Department, Dadra & Nagar Haveli
apisetu.gov.in
Driving License (DL) and Vehicle Registration Certificate (RC) of the State, as available on Parivahan Sewa (http://parivahan.co.in/) of Ministry of Road Transport and Highways, are available on DigiLocker. Citizens can pull these documents into their DigiLocker accounts.
Department of Legal Metrology, Uttar Pradesh
apisetu.gov.in
Licenses issued by Department of Legal Metrology, Uttar Pradesh can be pulled by citizens into their DigiLocker accounts.
OpenTrials API
opentrials.local