Versions Compared

Old Version 14

changes.mady.by.user Richard [RG]

Saved on

compared with

New Version Current

changes.mady.by.user Emily T [RG]

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Version 5 of the RescueGroups.org API is currently under development.  On 2/15/18, we released an alpha developer preview of RescueGroups.org API v5. This is a very early release involving only the Animals endpoint.

On 10/5/19 we released a major update to the v5 API.  Please see the notes below.

On 1/24/20 we released a minor update to the v5 API.  This update involved mostly changes to the backend.  Please see the notes below.

This API will change in the coming months.  We would greatly appreciate your feedback and ideas for improvement.  However, perform development at your own risk.  We would expect changes to be relatively minor, but there's no guarantee.

Full API documentation

Please visit the full API documentation (for the Production environment): https://api.rescuegroups.org/v5/public/docs

Please visit the full API documentation (for the Test environment): https://test1-api.rescuegroups.org/v5/public/docs

Warning

The Test environment is a copy of production data. However, this copy may be several days or weeks old and should not be considered valid. You are not permitted to use data you retrieve from the Test servers in any production (publicly accessible) service or website.


Changes and improvements of note

...

Improvements/changes made with the update on 10/5/19

  • If an attribute or relationship doesn't exist (ie., is null), that element will no longer be returned in the result. This will result in smaller results transfer sizes and make it easier to read and understand result data.
  • Compression (gzip) has been enabled on the API server.
  • All entity meta properties are now returned as entity attributes. Meta is only provided at the top-level of the response data.
  • The top-level meta data now includes more information about the request and results, including a transactionId that can be used when requesting assistance from RescueGroups.org.
  • We're simplifying the API by removing endpoints that weren't being used.
  • Endpoints are now grouped in the documentation so that all endpoints of the same type (eg., animals) are together.

Improvements/changes made with the update on 1/24/20

  • Geolocation now accepts postalcode, coordinates, or lat and lon in order to calculate distance for animals and organizations. Refer to the Endpoint reference for more information about how to perform a distance query for animals or organizations.

Swagger definition available soon

Coming soon!  You can download an early draft of our Swagger definition for the public API animals endpoint: https://test1-api.rescuegroups.org/v5/public/swagger.phpendpoints.

To open the definition go to the Swagger Editor and click File > Import URL and paste the URL above, once it's available.

Postman collection available

...

We also have a public Postman collection available to help you with examples.

...

We don't have any ETA for production release yet.   We are hoping that it will be in production by early-2020Please note, we do have a production environment URL that should be used if you choose to use this API to display data on publicly available websites.

Question: Will the current APIs (v2 and the REST API) be deprecated?

...