51Degrees API Documentation  4.2

Home

51Degrees API Documentation

Using the 51Degrees API to integrate real-time data insights into your own services involves a few steps.

  1. Create a Resource Key to authenticate your requests
  2. Obtain the programming library for your choice of language
  3. Choose your service: reverse geocoding, device detction, or others
  4. Query the APIs for the data you need

Each of these steps are described in more detail in this documentation and below.

Authentication with a Resource Key

To create a Resource Key, use the Configurator to select the data you need returned. Read Configurator explanation for more detail on how to create a resource key and errors that may occur.

Choose a programming library

There are programming libraries available in C#, Java, Node.js, client-side JavaScript, PHP, and Python for each of the services.

Choosing your service

  • Device Detection - Detailed insight into the devices being used to access your content.
  • Reverse Geocoding - Obtain accurate real-world data such as postal address from the users' location as reported by their smart phone or similar device.

Query the APIs

Querying 51Degrees APIs is done by constructing a Pipeline and adding Evidence to it and then telling it to process to get the best data for that evidence; for example, a location request might involve creating a Pipeline and adding an IP address to it and then processing to receive a latitude and longitude associated with that IP address.

To get started, next see real examples of how to obtain resource keys and query the APIs in detail in the quick start.

For further detail once the quick start is completed, please see the Advanced documentation in the menu. Pipelines are described in more detail in the basic pipeline description, which explains how pipelines are constructed from flow elements and consume flow data. Reference documentation for the HTTP API is provided in the cloud API documentation.