Documentation

Translator's Notes API Documentation

This documentation provides instructions for developers on how to access and utilize the Translator’s Notes Metadata and Translator’s Notes APIs.

Authentication

Both APIs require an API key for access. Please contact the API provider for information on obtaining a key. The key should be included as a query parameter named api_key in all requests.

Translator's Notes Metadata API

This API provides metadata about available Translator’s Notes files.

Requested URL:

GET https://translator-notes-metadata.apis.sil.org/?api_key=your_api_key

The API returns a JSON object containing a list of available resources. Each resource object includes the following information:

• ScriptureUnitCode: The code for the scripture unit (e.g., “1JN”)
• ScriptureUnitName: The name of the scripture unit (e.g., “1 John”)
• LanguageCode: The language code (e.g., “eng”)
• LanguageName: The language name (e.g., “English”)
• FileNameFor_TND_SFM: The filename of the Translator’s Notes Draft in SFM format
• FileNameFor_TND_PDF: The filename of the Translator’s Notes Draft in PDF format (may be null)
• FileNameFor_TNN_SFM: The filename of the Translator’s Notes in SFM format
• FileNameFor_TNN_PDF: The filename of the Translator’s Notes in PDF format (may be null)

This request will return a list of all available Translator’s Notes files with their corresponding metadata.

Example Response:

{ "resource": [ { "ScriptureUnitCode": "1JN", "ScriptureUnitName": "1 John", "LanguageCode": "eng", "LanguageName": "English", "FileNameFor_TND_SFM": "631JNOpenTND.SFM", "FileNameFor_TND_PDF": "631JNOpenTND.PDF", "FileNameFor_TNN_SFM": "631JNOpenTNN.SFM", "FileNameFor_TNN_PDF": "631JNOpenTNN.PDF" }, ... ] }


Translator's Notes API

This API provides access to the actual content of the Translator’s Notes files.

Requested URL:

GET https://translators-notes.apis.sil.org/filename?api_key=your_api_key

The API returns the content of the specified Translator’s Notes file in the format indicated by the filename extension (e.g.,SFM or PDF).

Example URL for 631JNOpenTND.SFM: 

GET https://translators-notes.apis.sil.org/631JNOpenTND.SFM?api_key=your_api_key

This request will return the content of the “631JNOpenTND.SFM” file, which contains the Translator’s Notes Draft for 1 John in SFM format.

Developer Workflow

Here’s a typical workflow for using these APIs:

1. Use the Translator’s Notes Metadata API to obtain a list of available files and their corresponding metadata.
2. Based on the desired scripture unit and language, identify the appropriate filename from the metadata.
3. Use the Translator’s Notes API with the chosen filename to download the content of the file.
4. Parse and utilize the downloaded data as needed in your application.