Open navigation

How should I describe my API Pull?

To create an offering via API, you must describe each of the URLs that is available in that offering. To validate this step, you must indicate:

  • A name: strictly indicative information that enables your acquirers to understand the logic of your API and the data that is available for the URL in question.
  • URL: exact URL
  • Type of query: GET or POST (how information is sent, depending on sensitivity)
  • Data output format: indicative information that tells your acquirers the output format for your data (CSV, JSON, XML, etc.).
  • Parameters: Parameters are detected automatically when your URL is saved. You may change, add, or delete them at any time.

Three methods are available for sending: in the URL, in the path, or in the body of the query. Each parameter may be optional.

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.