canonical: https://jentic.com/apis/perlego.com/perlego # Perlego Partner API The Perlego Partner API lets a partner manage the users and access it provides to Perlego's digital book library. You create and update user records, read and change the entitlements that grant a user access to the library, and mint an access token for a user session. It is aimed at institutions, resellers, and platforms that give their own members reading access through Perlego and need to keep that membership and its entitlements in sync with their own systems. ## For AI agents Manage Perlego library access for a partner: create and update users, read and change their entitlements, and mint an access token for a user. ## Scope Manages partner users, their entitlements, and access tokens for the Perlego library. Does not deliver book content or search the catalogue through these endpoints, and does not handle billing or payment for the subscription. ## Capabilities - List the users under a partner account - Create a new user and update an existing user record - Read the entitlements that grant a user library access - Grant an entitlement to a user - Remove an entitlement from a user - Mint an access token for a user session ## Use cases ### Provision members for library access Keep a partner's members in step with Perlego. The agent creates and updates user records so the people who should have reading access exist in Perlego, matching the partner's own membership list. Example prompt: Create or update the user records so a partner's members exist in Perlego and are ready for entitlements. ### Manage entitlements to the library Control who can read through Perlego. The agent reads a user's entitlements and grants or removes them, so access matches a member's current plan or subscription status. Example prompt: Read a user's entitlements, then grant or remove entitlements so their access matches their current status. ### Start a reading session for a user Hand a member into Perlego from a partner's own product. The agent mints an access token for the user so a reading session can start without the member managing separate Perlego credentials. Example prompt: Mint an access token for the given user so a reading session can begin from the partner's product. ### Reconcile access with membership Keep library access honest as membership changes. The agent lists users and their entitlements so a partner can compare them against its own records and correct any drift. Example prompt: List the users and read their entitlements so a partner can reconcile Perlego access against its own membership records. ## Key endpoints | Method | Path | Description | | --- | --- | --- | | GET | `/users` | List the users under the partner account | | POST | `/user` | Create a new user | | GET | `/user/{userId}` | Read a single user | | GET | `/user/{userId}/entitlements` | List a user's entitlements | | POST | `/user/{userId}/entitlement` | Grant an entitlement to a user | ## Key resources - **User** — A partner member record that library access is attached to. - **Entitlement** — A grant that gives a user access to the Perlego library. - **Access token** — A short-lived token that lets a user start a reading session. ## AI readiness This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use. - **Score:** 54 / 100 - **Maturity:** Foundational - **Dimensions:** - Foundational Compliance: 67 / 100 - Developer Experience & Jentic Compatibility: 69 / 100 - AI-Readiness & Agent Experience: 48 / 100 - Agent Usability: 94 / 100 - Security: 25 / 100 - AI Discoverability: 61 / 100 - **View full report:** https://jentic.com/apis/perlego.com/perlego/scorecard - **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/ - **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview ### Score it yourself Every API in the directory is allowlisted, so you can re-score it with no key required. - **Score your own API:** https://jentic.com/scorecard.md - **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md ```sh npx @jentic/api-scorecard-cli score ``` ## Why Jentic - **Setup:** Wiring the Perlego Partner API by hand means provisioning API key or HMAC-SHA256 credentials, learning how users, entitlements, and access tokens relate, and mapping the endpoints. Through Jentic you install once, import the Perlego Partner API from the Jentic API Directory, configure your credentials, and your agent calls it. - **Permission scoping:** Provisioning users and changing entitlements sit behind the same credentials, and because Jentic One is self-hosted, your own rules decide which operations the agent may call. You can allow reading users and entitlements while withholding operations that grant or remove access, so the agent reaches only what you approved. - **Credential handling:** Your Perlego API key or HMAC-SHA256 credentials are held encrypted by your own Jentic One instance and applied to requests only at execution time. They never enter the agent's prompt, logs, or context. - **Discovery method:** Agents search Jentic by intent, such as granting an entitlement or minting an access token, and Jentic returns the matching Perlego operation with typed inputs, so the agent calls the right one without hard-coding endpoints. ## Related APIs - **Google Books API** — Search book metadata and previews across a large catalogue - **ISBNdb API** — Look up book details and pricing by ISBN - **BookStack API** — Manage users and content in a self-hosted knowledge library ## FAQ ### What authentication does the Perlego Partner API use? Each operation accepts one of two options: an API key sent in the x-api-key header, or an HMAC-SHA256 request signature. Through Jentic, whichever credentials you configure are held encrypted by your own Jentic One instance and applied to requests at execution time. Check Perlego's partner documentation for how to obtain them. ### What does an entitlement control in the Perlego Partner API? An entitlement is the grant that gives a user access to the Perlego library. You read a user's entitlements and grant or remove them, so a member's reading access matches their current plan or subscription. ### What are the rate limits for the Perlego Partner API? The OpenAPI description does not specify rate limits. Check Perlego's partner documentation for the limits on your account before provisioning users or entitlements in bulk. ### Is there an MCP server for Perlego? You don't need an MCP server to use the Perlego Partner API with your agent. Through Jentic, your agent finds the user and entitlement operations by intent and calls them directly, with your credentials injected at run time by your own Jentic One instance. ### How do I connect the Perlego Partner API to my agent through Jentic? To run it on your own infrastructure, install Jentic One from its GitHub repo, then import the Perlego Partner API from the Jentic API Directory and configure your API key or HMAC-SHA256 credentials. Your agent can then manage users and entitlements with those credentials injected at execution time. ### Can I limit what my agent is allowed to do with the Perlego Partner API? Yes. Because Jentic One is self-hosted, your own rules decide which Perlego operations the agent may call, so you can allow reading users and entitlements while withholding operations that grant or remove access. Your credentials stay encrypted on your own instance and are applied only when a permitted request runs.