Yinxiang (China) | Alephant Documentation

The Yinxiang China connector uses the official Developer Token and NoteStore API. It is read-only, indexes one explicitly selected notebook, and can index note resources as child documents.

Scope and behavior

The connector uses the app.yinxiang.com production service, keeps a checkpoint for incremental sync, validates the selected notebook against listNotebooks, and filters synchronized notes by that notebook GUID.

Treat a Developer Token like a password. Do not commit it to source control or include it in screenshots. Revoke and regenerate it from the Developer Token page if it may have been exposed.

Prerequisites

Create a production token, confirm the target notebook is accessible, and ensure the Alephant deployment can reach the NoteStore URL.

Step 1: Get a Developer Token

Open the production Developer Token page, create a token, and copy the complete value beginning with S=.

The official documentation distinguishes production and sandbox token pages. Use matching token, NoteStore URL, and account environments.

Step 2: Get the NoteStore URL

Copy the full URL shown with the token. It normally looks like:

https://app.yinxiang.com/shard/{shardId}/notestore

Step 3: Get the Notebook GUID

Option A: Read `listNotebooks`

1 token = "<developer-token>"
2 note_store_url = "https://app.yinxiang.com/shard/{shardId}/notestore"
3 for notebook in note_store.listNotebooks(token):
4     print(notebook.name, notebook.guid)

Option B: Use the returned `guid`

Use the target notebook’s guid, not its name, account ID, or shard ID.

Step 4: Configure the connector

Field	Value	Check
Developer Token	Complete token	Same account and environment as the NoteStore URL.
NoteStore URL	Full URL from the token page	Must end in `/shard/{shardId}/notestore`.
Notebook GUID	The selected notebook’s `guid`	Required and present in `listNotebooks`.
Include attachments	Optional	Index returned resources as child documents.
Access scope	Approved Alephant scope	Source permissions do not replace Alephant permissions.
Connector name	A descriptive name	Do not include the token.

Verification checklist

Run an indexing attempt and confirm it succeeds.
Search a known note title and a keyword from an unselected notebook.
If validation fails, re-check the token, NoteStore URL, and GUID as one matching set.
If attachments are missing, check the attachment switch and parser support.

Troubleshooting

Symptom	First check
Notebook GUID validation fails	Use `listNotebooks` and copy the exact `guid`.
Authorized notebook not found	Token, URL, and GUID may belong to different environments or accounts.
`DATA_CONFLICT` for `notebookFilter`	The connector synchronizes a general chunk and filters by GUID locally.
Token or URL error	Do not mix sandbox and production values.
Attachments are missing	Check the attachment switch and parser support.

Official references

Official Developer Token creation page

Yinxiang China Developer Token and NoteStore URL page with sensitive values redacted

Official Developer Token creation result example