create_client

POST to this endpoint to register a new client application with the Foxy API. This is the same as the client resource, but is the POST-only creation endpoint.

When creating a client resource, the response will include the OAuth Access and Refresh tokens required to work with this resource via the API. It's important to save this information in your database. If you lose it, you'll have to do an OAuth Authorization Code grant via your browser. The response also includes the client_id and client_secret which are needed to refresh your access tokens and work with OAuth 2.0.

Actions

POST Create a new client
OPTIONS Get a response explaining which HTTP methods are supported

Properties (10)

client_id String · max 200

A unique identifier for this client. If you do not supply one, one will be automatically generated for you.

Unique. Between 15 and 200 characters.

redirect_uri String · Required · max 200

This is the redirection endpoint as described by OAuth 2.0.

project_name String · Required · max 100

The name of this project which will be using the API.

project_description String · max 200

A description of this project.

company_name String · Required · max 100

The name of the company responsible for this project.

company_url String · max 200

The URL of the company responsible for this project.

company_logo String · max 200

An image URL for this company.

contact_name String · Required · max 100

The individual responsible for this integration.

contact_email String · Required · max 100

The email address of the individual responsible for this integration.

contact_phone String · Required · max 100

The phone number of the individual responsible for this integration.

https://api.foxycart.com/create_client/{id}
Available via fx:create_client on api_home

Example Representation

No example representation available for this resource.