If you are already fetching documents directly from integration partners like OneDrive, Google Drive, Dropbox, etc., and now want to use fetchdocs as unified API to fetch documents from multiple integrations, you can migrate your existing connections to fetchdocs.
Migrating connections allows the usage of fetchdocs with a minimal required interaction by the user. OAuth integrations require the user to authenticate with the integration provider to allow fetchdocs to fetch documents from the integration. Integrations using credentials or API keys, in most cases, don't require any user interaction.
You need to migrate each connection individually. The migration process is more or less the same as the creation process. The only differences are the required fields for the connection.
Before you start the migration process, you must create an identity in fetchdocs. For more details see Create an Identity.
When you have the identity, you can start the migration process, by posting the required data to the POST /connections/migrate endpoint of the fetchdocs API.
The required data for the migration are:
β οΈ The required fields for the connection depend on the integration.
If you want to migrate a connection, you need to know the required fields for the connection. The fetchdocs team provides the required fields to you.
The response of the request has the HTTP status code 201 on success. It contains the uuid of the connection. You need to store this uuid in your app to use it for further requests regarding the connection.
If required fields are missing, the request fails with a 422 Unprocessable Entity status code and shares the missing fields in the error response.
As soon as the connection is successfully migrated, you should delete the credentials from your app. This way you can ensure that the credentials aren't used anymore.
π API reference
For more information about the API endpoint
POST /connections/migrate, please refer to the API reference.
If you need help with the migration process, please contact the fetchdocs support team. They're happy to assist you.