Date: Fri, 29 Mar 2024 10:23:57 +0000 (UTC) Message-ID: <470308847.7.1711707837564@ip-10-20-11-151.ec2.internal> Subject: Exported From Confluence MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_Part_6_1131195841.1711707837561" ------=_Part_6_1131195841.1711707837561 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Content-Location: file:///C:/exported.html
The RescueGroups.org HTTP API is the only one of its kind =E2=80=93 a po= werful platform for data management and public data searches.
The RescueGroups.org HTTP API is the ONLY updatable animal data = API available. In fact, there are a lot of reasons that the RescueGroups.org is th= e best API to use for your project.
For additional information about the API, or to request your own public = API key, please visit our API service page: http://www.rescuegroups.org/services/adoptable-pet-data-api/
If you plan to use public data you should request a RescueGroups.org API= key. It is not recommended to use your RescueGroups.org user name to query= public data!
The HTTP API receives and responds with data in JSON format via an HTTP = POST. Most programming languages have built-in JSON encoding and deco= ding functions.
Please see below for additional information and examples on how to query= for public and private data using the API.
Here are the major components of the RescueGroups.org HTTP API:
See the examples page for additio= nal information on public searches.
Public access is granted to some data in the RescueGroups.org system.&nb= sp; This includes public animal information and public organization informa= tion.
To use the HTTP API for animal and organization queries you need only an= API Key. You do not need to login to the HTTP API or create a token = to access public data if you have an API Key. You can request an API = Key from theAdoptable Pet Data API page.
A lot of public information is available from the RescueGroups.org API i= ncluding:
See the examples page for additio= nal information on private searches.
Access to non-public information requires a valid RescueGroups.org accou= nt, as well as a valid user name and password and permission to the object/= information you are requesting.
Before you can request non-public information you will need to authentic= ate. Authentication is done with the login action, and then the token and token hash values= you receive must be sent with each request that requires authentication.= p>
See the login page = for more information on the login request and response.
Using your RescueGroups.org account number, user name and password, you = can gain access to the RescueGroups.org platform, including:
Sending a response to the HTTP API is very simple. In your favorit= e programming language, create an array of the data you want to send. = Encode that data in JSON format, and POST the data via HTTPS.
The HTTP API uses only HTTP POST requests (the API will not respond to G= ET requests).
See the appropriate User Guide pages for the format of the data to submi= t for the object or action you are trying to perform. The required da= ta is different between most actions and objects.
With PHP you could create an array and encode the array into JSON format= using the json_encode() function.
To perform the HTTP POST with PHP you can use the c= url libraries.
The URL for the HTTP API is:
https://api.rescu=
egroups.org/http/v2.json
Responses from the HTTP API will be in JSON format. Decode the res= ponse and handle the data as appropriate with your favorite programming lan= guage.
See the appropriate User Guide pages for the format of the response data= action you are trying to perform. The response is different between = most actions.
With PHP you could decode the JSON response using the json_decode() function.