Authentication with the Yandex Vision OCR API
Get your account data for authentication:
-
Get an IAM token for your Yandex account or federated account.
-
Get the ID of the folder for which your account has the
ai.vision.userrole or higher. -
When accessing Vision OCR via the API, provide the received parameters in each request:
-
For the Vision API and Classifier API:
Specify the IAM token in the
Authorizationheader as follows:Authorization: Bearer <IAM_token>Specify the folder ID in the request body in the
folderIdparameter. -
For the OCR API:
- Specify the IAM token in the
Authorizationheader. - Specify the folder ID in the
x-folder-idheader.
Authorization: Bearer <IAM_token> x-folder-id <folder_ID> - Specify the IAM token in the
-
Vision OCR supports two authentication methods based on service accounts:
-
With an IAM token:
-
Get an IAM token.
-
Provide the IAM token in the
Authorizationheader in the following format:Authorization: Bearer <IAM_token>
-
-
With API keys.
API keys do not expire. This means that this authentication method is simpler, but less secure. Use it if you can't automatically request an IAM token.
-
Provide the API key in the
Authorizationheader in the following format:Authorization: Api-Key <API key>
Do not specify the folder ID in your requests, as the service uses the folder the service account was created in.