Completed 2023-04-11: Deprecation of API key management endpoints

On April 11, 2023, Codat will deprecate endpoints used to manage APIAPI A set of rules and protocols that allows different software applications to communicate with each other. Codat provides APIs for accessing financial data from accounting, banking, and commerce platforms. keys. This is to support our extended APIAPI A set of rules and protocols that allows different software applications to communicate with each other. Codat provides APIs for accessing financial data from accounting, banking, and commerce platforms. key management that allows multiple keys.

We are extending our APIAPI A set of rules and protocols that allows different software applications to communicate with each other. Codat provides APIs for accessing financial data from accounting, banking, and commerce platforms. key management to allow the generation of multiple APIAPI A set of rules and protocols that allows different software applications to communicate with each other. Codat provides APIs for accessing financial data from accounting, banking, and commerce platforms. keys as part of our journey toward granular permission sets. Current public APIAPI A set of rules and protocols that allows different software applications to communicate with each other. Codat provides APIs for accessing financial data from accounting, banking, and commerce platforms. endpoints are designed to manage a single APIAPI A set of rules and protocols that allows different software applications to communicate with each other. Codat provides APIs for accessing financial data from accounting, banking, and commerce platforms. Key, so will need to be deprecated to avoid undesirable behavior.

The change impacts the following endpoints:

• Endpoint PUT /Profile/apiKey will be removed,
• Endpoint GET /profile will change to remove the property apiKey.

Update - 2023/02/16

This was previously scheduled for 2023/04/10. This has been pushed back a day as this fell on a public holiday in the UK.

Action required

Use the Codat Portal to view and generate APIAPI A set of rules and protocols that allows different software applications to communicate with each other. Codat provides APIs for accessing financial data from accounting, banking, and commerce platforms. keys in the interim. The APIAPI A set of rules and protocols that allows different software applications to communicate with each other. Codat provides APIs for accessing financial data from accounting, banking, and commerce platforms. keys can be managed under Developers > APIAPI A set of rules and protocols that allows different software applications to communicate with each other. Codat provides APIs for accessing financial data from accounting, banking, and commerce platforms. keys.

Expected impact if no action is taken

After the change is implemented, a call to the PUT /Profile/apiKey endpoint will start returning a 404 response, and the GET /profile endpoint will return an object without the apiKey property.

Additional information

Current public APIAPI A set of rules and protocols that allows different software applications to communicate with each other. Codat provides APIs for accessing financial data from accounting, banking, and commerce platforms. endpoints are designed to manage a single APIAPI A set of rules and protocols that allows different software applications to communicate with each other. Codat provides APIs for accessing financial data from accounting, banking, and commerce platforms. key, and their existing logic can result in unexpected behavior when faced with multiple APIAPI A set of rules and protocols that allows different software applications to communicate with each other. Codat provides APIs for accessing financial data from accounting, banking, and commerce platforms. keys, such as:

• PUT /Profile/apiKey
  A client, who created multiple APIAPI A set of rules and protocols that allows different software applications to communicate with each other. Codat provides APIs for accessing financial data from accounting, banking, and commerce platforms. keys via the Portal, will have their existing APIAPI A set of rules and protocols that allows different software applications to communicate with each other. Codat provides APIs for accessing financial data from accounting, banking, and commerce platforms. keys deleted and a new APIAPI A set of rules and protocols that allows different software applications to communicate with each other. Codat provides APIs for accessing financial data from accounting, banking, and commerce platforms. key created instead.

• GET /profile
  The apiKey property of this endpoint response will contain only the first APIAPI A set of rules and protocols that allows different software applications to communicate with each other. Codat provides APIs for accessing financial data from accounting, banking, and commerce platforms. key.

Get ahead

You can get ahead of this change by enabling it now in the Portal. Learn how to do that here, or read our change policy.