### Response Example (JSON) Source: https://developers.eduzz.com/reference/api/get-heycamp-v1-posts-community-communityId-total-comments This is an example of a successful response (200 OK) showing the total number of comments. ```json { "totalComments": 40 } ``` -------------------------------- ### Example Response for Product Partners (JSON) Source: https://developers.eduzz.com/reference/api/get-myeduzz-v1-products-id-partners This is an example of a successful JSON response (200 OK) when retrieving product partners. It includes partner IDs, names, emails, commission details, and permissions. ```json [ { "id": "1234", "name": "Eduzz", "email": "eduzz@eduzz.com", "commission": { "type": "percentage", "value": 90, "onlyByAffiliate": false }, "permission": { "canManageAffiliates": true, "canRefund": true, "canViewCustomerData": true } }, { "id": "4321", "name": "Parceiro Eduzz", "email": "parceiro@eduzz.com", "commission": { "type": "percentage", "value": 10, "onlyByAffiliate": false }, "permission": { "canManageAffiliates": false, "canRefund": false, "canViewCustomerData": false } } ] ``` -------------------------------- ### Example User Data Response Source: https://developers.eduzz.com/docs/api/personal-token This is an example of the JSON response you will receive when successfully testing your access token against the '/accounts/v1/me' endpoint. ```json { "id": "00000000-0000-0000-0000-000000000000", "name": "Fulano da Silva", "email": "fulanodasilva@gmail.com" } ``` -------------------------------- ### Affiliate List Response Example Source: https://developers.eduzz.com/reference/api/get-myeduzz-v1-affiliates This is an example of a successful (200 OK) response when listing affiliates. It includes pagination information and an array of affiliate objects, each with details about their status, product, and customer. ```json { "pages": 1, "page": 1, "itemsPerPage": 10, "totalItems": 1, "items": [ { "id": "32366478", "status": "approved", "requestedAt": "2024-06-17T17:25:31.000Z", "approvedAt": "2024-06-17T17:25:31.000Z", "updatedAt": "2024-06-17T17:25:32.150Z", "createdAt": "2024-06-17T17:25:31.470Z", "product": { "id": "1739854", "name": "Produto de exemplo" }, "customer": { "id": "74452654", "name": "José da Silva" } } ] } ``` -------------------------------- ### User Data Response Example (JSON) Source: https://developers.eduzz.com/reference/api/get-accounts-v1-me This is an example of a successful JSON response when retrieving user data. It includes the user's ID, name, and email. ```json { "id": "dcc44cb7-30c8-46ef-b35b-ffacf8cc61d1", "name": "Fulano da Silva", "email": "fulano.silva@example.com" } ``` -------------------------------- ### Webhook Testing and Event Examples Source: https://developers.eduzz.com/swagger Endpoints for testing webhook functionality and retrieving examples of available events. ```APIDOC ## POST /webhook/v1/subscription/sample ### Description Requisita o envio do teste de um WebHook. ### Method POST ### Endpoint /webhook/v1/subscription/sample ``` ```APIDOC ## GET /webhook/v1/origin/sample/:event ### Description Lista de exemplos dos eventos de webhooks disponíveis em cada origem. ### Method GET ### Endpoint /webhook/v1/origin/sample/:event ``` -------------------------------- ### Get Product Details (Shell) Source: https://developers.eduzz.com/reference/api/get-myeduzz-v1-products-id Use this cURL command to make a GET request to the Eduzz API to retrieve details for a specific product. Ensure you have the necessary permissions. ```shell curl --request GET \ --url 'https://api.eduzz.com/myeduzz/v1/products/cb655282-1903-402f-a02d-1f78cd388426' \ --header 'Accept: application/json' ``` -------------------------------- ### Bank Slip Installment Information Source: https://developers.eduzz.com/reference/webhook/myeduzz-invoice-chargeback Details about installments for payments made via bank slip. ```APIDOC ## Bank Slip Installment Information ### Description Information about installments for bank slip payments. ### Fields - **data.bankSlipInstallment.installmentNumber** (number) - Número da parcela. - **data.bankSlipInstallment.totalInstallments** (number) - Total de parcelas. ``` -------------------------------- ### Bank Slip Installment Data Structure Source: https://developers.eduzz.com/reference/webhook/myeduzz-invoice-waiting-refund Details information about installments for bank slip payments. ```APIDOC ## Bank Slip Installment Data Structure ### Description Provides details about payment installments when using a bank slip, especially for split payments. ### Fields - **data.bankSlipInstallment** (object) - Nullable - Information about bank slip installments. - **data.bankSlipInstallment.installmentNumber** (number) - Required - The current installment number. - **data.bankSlipInstallment.totalInstallments** (number) - Required - The total number of installments for the payment. ``` -------------------------------- ### List All Products (Shell) Source: https://developers.eduzz.com/reference/api/get-myeduzz-v1-products Use this command to fetch all products registered under a producer's account. Ensure you have the necessary 'myeduzz_products_read' scope. ```shell curl --request GET \ --url 'https://api.eduzz.com/myeduzz/v1/products' \ --header 'Accept: application/json' ``` -------------------------------- ### Atualizar customização do curso via API Source: https://developers.eduzz.com/reference/api/put-nutror-v1-courses-courseId-customization Exemplos de requisição para atualizar as configurações visuais de um curso. ```Shell curl --request PUT \ --url 'https://api.eduzz.com/nutror/v1/courses/:courseId/customization' \ --header 'Accept: application/json' ``` -------------------------------- ### Product Listing Response (JSON) Source: https://developers.eduzz.com/reference/api/get-myeduzz-v1-products This is an example of a successful response (200 OK) when listing products. It includes pagination details and a list of product objects, each with its own set of properties. ```json { "pages": 821, "page": 1, "itemsPerPage": 3, "totalItems": 2461, "items": [ { "id": "47998", "name": "Produto Digital Básico", "description": "Produto digital básico para teste e validação do sistema.", "producerId": "1234", "type": "digital", "status": "active", "author": "Eduzz", "moderation": "pending", "imageUrl": "https://cdn.eduzzcdn.com/xpto.jpg", "createdAt": "2018-03-20T16:24:47.180Z", "updatedAt": "2023-05-15T18:46:44.647Z", "payment": { "type": "oneTime", "price": { "currency": "BRL", "value": 1.1 }, "methods": { "bankslip": true, "pix": true, "card": true, "multipleCards": true } } }, { "id": "48015", "name": "Produto de Assinatura", "description": "Produto de assinatura para teste e validação contínua.", "producerId": "1234", "type": "digital", "status": "active", "author": "Eduzz", "moderation": "new", "imageUrl": "https://cdn.eduzzcdn.com/xpto.jpg", "createdAt": "2018-03-20T17:20:05.567Z", "updatedAt": "2023-05-15T18:46:44.647Z", "payment": { "type": "subscription", "price": { "currency": "BRL", "value": 10 }, "methods": { "bankslip": true, "pix": true, "card": true, "multipleCards": true } } }, { "id": "48045", "name": "Produto Premium", "description": "Produto premium com funcionalidades avançadas.", "producerId": "1234", "type": "physical", "status": "inactive", "author": "Eduzz", "moderation": "approved", "imageUrl": "https://cdn.eduzzcdn.com/xpto.jpg", "createdAt": "2018-03-20T19:57:44.357Z", "updatedAt": "2023-05-15T18:46:44.647Z", "payment": { "type": "oneTime", "price": { "currency": "BRL", "value": 100 }, "methods": { "bankslip": true, "pix": true, "card": true, "multipleCards": false } } } ] } ``` -------------------------------- ### Configurar servidor MCP no Claude Desktop Source: https://developers.eduzz.com/docs/integrations/mcp Adicione esta configuração ao arquivo de configuração do Claude Desktop para permitir que o aplicativo acesse a API da Eduzz. ```json { "mcpServers": { "eduzz-api": { "type": "streamableHttp", "url": "https://developers.eduzz.com/api/mcp" } } } ``` -------------------------------- ### Example Response for Listing Comments Source: https://developers.eduzz.com/reference/api/get-heycamp-v1-comments-on-post-postId-community-communityId This is an example of a successful (200) response when listing comments on a post. It includes post details, member information, associated comments, and replies. ```json { "id": 1, "title": "Post 1", "createdAt": "2024-10-21T18:02:22.000Z", "member": { "id": 1, "name": "Membro 1" }, "comments": [ { "id": 1, "text": "Comentário 1", "createdAt": "2024-10-21T18:02:22.000Z", "member": { "id": 1, "name": "Membro 1" } } ], "replies": [ { "id": 1, "text": "Resposta 1", "createdAt": "2024-10-21T18:02:22.000Z", "member": { "id": 1, "name": "Membro 1" } } ] } ``` -------------------------------- ### Get Student Profile (Shell) Source: https://developers.eduzz.com/reference/api/get-nutror-v1-students-id Use this command to make a GET request to the API to retrieve a student's profile information. Ensure you have the correct student ID. ```shell curl --request GET \ --url 'https://api.eduzz.com/nutror/v1/students/9b71e95310b7464bb6ca910ab3036372' \ --header 'Accept: application/json' ``` -------------------------------- ### List Product Coupons Response Source: https://developers.eduzz.com/reference/api/get-myeduzz-v1-products-coupons Example of a successful 200 OK response containing a list of coupons and their associated product details. ```JSON { "pages": 821, "page": 1, "itemsPerPage": 3, "totalItems": 2461, "items": [ { "code": "CUPOM123", "description": "Cupom simples", "value": 10, "type": "value", "quantity": 1000, "limitDate": "2029-03-20T16:24:47.180Z", "products": [ { "id": "1234", "title": "Produto Simples 1", "price": { "currency": "BRL", "value": 200 }, "priceWithDiscount": { "currency": "BRL", "value": 190 }, "link": "https://linkdevenda/produto?cupom=CUPOM123" } ] }, { "code": "CUPOM456", "description": "Cupom complexo", "value": 10, "type": "percentage", "quantity": 1000, "limitDate": "2029-03-20T16:24:47.180Z", "products": [ { "id": "1234", "title": "Produto Simples 1", "price": { "currency": "BRL", "value": 200 }, "priceWithDiscount": { "currency": "BRL", "value": 180 }, "link": "https://linkdevenda/produto?cupom=CUPOM456" }, { "id": "12345", "title": "Produto Simples 2", "price": { "currency": "BRL", "value": 500 }, "priceWithDiscount": { "currency": "BRL", "value": 450 }, "link": "https://linkdevenda/produto?cupom=CUPOM456" } ] } ] } ``` -------------------------------- ### Payload for nutror.lesson_started Source: https://developers.eduzz.com/reference/webhook/nutror-lesson-started Example JSON payload received when a student initiates a lesson. ```json { "id": "qs1fcic3rm1oxw25fgup6mumv", "event": "nutror.lesson_started", "data": { "producer": { "email": "fulano@eduzz.com", "name": "Fulano da Silva" }, "learner": { "email": "learner@eduzz.com", "name": "Ciclano da Silva" }, "course": { "hash": "4bba1d18c02755a13ee97521ae61958c3cf9e665", "title": "Título do Curso" }, "lesson": { "id": "3866", "title": "Título da Aula" }, "createdAt": "2023-09-25T19:17:32Z" }, "sentDate": "2024-02-29T14:33:06.214Z" } ``` -------------------------------- ### Excluir mídia via API Source: https://developers.eduzz.com/reference/api/delete-safevideo-v1-medias-id Utilize este comando para realizar a exclusão de uma mídia específica pelo seu ID. ```Shell curl --request DELETE \ --url 'https://api.eduzz.com/safevideo/v1/medias/:id' \ --header 'Accept: application/json' ``` -------------------------------- ### Get Product Partners (Shell) Source: https://developers.eduzz.com/reference/api/get-myeduzz-v1-products-id-partners Use this cURL command to make a GET request to the Eduzz API to retrieve partners for a given product ID. Ensure you have the necessary 'myeduzz_products_read' scope. ```shell curl --request GET \ --url 'https://api.eduzz.com/myeduzz/v1/products/cb655282-1903-402f-a02d-1f78cd388426/partners' \ --header 'Accept: application/json' ``` -------------------------------- ### POST /webhook/v1/subscription/sample Source: https://developers.eduzz.com/reference/api/post-webhook-v1-subscription-sample Requisita o envio do teste de um WebHook para validar a integração. ```APIDOC ## POST /webhook/v1/subscription/sample ### Description Requisita o envio do teste de um WebHook. ### Method POST ### Endpoint https://api.eduzz.com/webhook/v1/subscription/sample ### Parameters #### Request Body - **subscriptionId** (string) - Required - Id da Configuração do WebHook - **event** (string) - Required - Nome do Evento ### Request Example { "subscriptionId": "gklzq82g9l0daazesebit6hds", "event": "test.event_one" } ### Response #### Success Response (201) - **statusCode** (number) - HTTP Status Code do WebHook - **body** (string) - Body retornado pela URL do WebHook - **timeTaken** (number) - Latência do processo e envio de WebHook em milisegundos #### Response Example { "statusCode": 200, "body": "{\"message\":\"Workflow was started\"}", "timeTaken": 322 } ``` -------------------------------- ### Get Customer Details via API (Shell) Source: https://developers.eduzz.com/reference/api/get-myeduzz-v1-customers-email Use this cURL command to make a GET request to the Eduzz API to retrieve a customer's details by their email. Ensure you have the necessary 'myeduzz_customers_read' scope. ```shell curl --request GET \ --url 'https://api.eduzz.com/myeduzz/v1/customers/buyer@teste.com' \ --header 'Accept: application/json' ``` -------------------------------- ### Atualizar curso via cURL Source: https://developers.eduzz.com/reference/api/put-nutror-v1-courses-courseId Exemplo de requisição PUT para atualizar informações básicas de um curso. ```Shell curl --request PUT \ --url 'https://api.eduzz.com/nutror/v1/courses/:courseId' \ --header 'Accept: application/json' ``` -------------------------------- ### Consultar Documentos Fiscais Source: https://developers.eduzz.com/reference/api/get-myeduzz-v1-financial-buyer-fiscal-documents Realiza uma requisição GET para listar os documentos fiscais do comprador. ```shell curl --request GET \ --url 'https://api.eduzz.com/myeduzz/v1/financial/buyer/fiscal-documents' \ --header 'Accept: application/json' ``` -------------------------------- ### Invoice Opened Webhook Example Source: https://developers.eduzz.com/api/openapi This example details the payload for a webhook when an invoice's status changes to 'open'. It includes comprehensive information about the invoice, buyer, producer, offer, UTM parameters, tracker codes, and items. ```json { "id": "zszf0uk65g701io8dbsckfeld", "event": "myeduzz.invoice_opened", "data": { "id": "12345678", "status": "open", "buyer": { "id": "66677677767", "name": "Alice Johnson", "document": "12333333", "email": "alice.johnson@example.com", "phone": "555-789-1234", "phone2": "555-987-6543", "cellphone": "555-321-9876", "address": { "street": "Rua avenida", "number": "123", "neighborhood": "Bairro", "complement": "Complemento", "city": "Cidade", "state": "Estado", "country": "Brasil", "zipCode": "12345-123" } }, "producer": { "id": "1454585458", "name": "Orbita", "email": "orbita@eduzz.com", "originSecret": "originsecrettest" }, "offer": { "name": "Oferta Base" }, "utm": { "source": "source", "campaign": "campaign", "medium": "medium", "content": "content", "term": "term" }, "tracker": { "code1": "tracking-1", "code2": "tracking-2", "code3": "tracking-3" }, "createdAt": "2024-01-09T14:45:00.000Z", "dueDate": "2024-01-13T17:45:00.000Z", "barcode": "88846758782537262653776655566", "price": { "currency": "BRL", "value": 301.5 }, "orderBump": { "has": true, "isMainSale": false, "mainSaleId": 123456 }, "installments": 1, "items": [ { "productId": "P567", "name": "Widget X", "parentId": "11111111", "refundPeriod": { "durationType": "days", "value": 7 }, "pri" } ] } } ``` -------------------------------- ### Get Sale Details with cURL Source: https://developers.eduzz.com/reference/api/get-myeduzz-v1-sales-id Use this cURL command to make a GET request to the Eduzz API to retrieve specific sales details. Ensure you replace ':id' with the actual sale ID. The 'Accept' header should be set to 'application/json'. ```shell curl --request GET \ --url 'https://api.eduzz.com/myeduzz/v1/sales/:id' \ --header 'Accept: application/json' ``` -------------------------------- ### Get Secret Source: https://developers.eduzz.com/api/openapi Retrieves the secret associated with an application. ```APIDOC ## GET /websites/developers_eduzz ### Description Retrieves the secret for a given application. ### Method GET ### Endpoint /websites/developers_eduzz ### Response #### Success Response (200) - **id** (string) - The unique identifier for the secret. - **name** (string) - The name of the application. - **appId** (string) - The application ID. - **secret** (string) - The application secret. - **default** (boolean) - Indicates if this is the default secret. #### Response Example ```json { "id": "o01re8ty3kanab3ufi5ref0s3", "name": "APP: 5accd2e8-869f-41d2-ae0d-3e314236f395", "appId": "5accd2e8-869f-41d2-ae0d-3e314236f395", "secret": "edzwgd_T9fKNbk0MG6jNRFUcyIcjknSCd6K0M7Z4xbojWnoj8xPQeWKuX", "default": false } ``` ``` -------------------------------- ### Configurar servidor MCP no Cursor Source: https://developers.eduzz.com/docs/integrations/mcp Adicione esta configuração ao arquivo .cursor/mcp.json na raiz do seu projeto para habilitar a integração com a API da Eduzz no editor Cursor. ```json { "mcpServers": { "eduzz-api": { "url": "https://developers.eduzz.com/api/mcp" } } } ``` -------------------------------- ### Alterar Mídia via API Source: https://developers.eduzz.com/reference/api/put-safevideo-v1-medias-id Utilize este comando para atualizar o título ou a descrição de uma mídia existente. Requer o escopo safevideo_contents_write. ```Shell curl --request PUT \ --url 'https://api.eduzz.com/safevideo/v1/medias/:id' \ --header 'Accept: application/json' ``` -------------------------------- ### GET /nutror/v1/courses Source: https://developers.eduzz.com/api/openapi Lists all courses available in the system. ```APIDOC ## GET /nutror/v1/courses ### Description Lists all courses available in the system. ### Method GET ### Endpoint /nutror/v1/courses ### Parameters No parameters are required for this endpoint. ### Response #### Success Response (200) - **id** (number) - The unique identifier of the course. - **title** (string) - The title of the course. - **hash** (string) - A unique hash for the course. - **createdAt** (string) - The date and time the course was created. - **updatedAt** (string) - The date and time the course was last updated. - **published** (boolean) - Indicates if the course is published. - **myEduzzAssociation** (object) - Information about the course's association with myEduzz. - **contentId** (string) - The content ID of the association. - **title** (string) - The title of the associated content. #### Response Example { "id": 12351, "title": "Novo curso!", "hash": "53bc09b45b1sdsdf438fc2ea87ac04d8faabb8d9", "createdAt": "2024-08-29T18:14:53Z", "updatedAt": "2024-08-29T18:14:53Z", "published": true, "myEduzzAssociation": { "contentId": "123548", "title": "Produto 1" } } ``` -------------------------------- ### Product Details Response (JSON) Source: https://developers.eduzz.com/reference/api/get-myeduzz-v1-products-id This is an example of a successful JSON response (200 OK) when requesting product details. It includes all relevant information about the product. ```json { "id": "48045", "name": "Produto Premium", "description": "Produto premium com funcionalidades avançadas.", "producerId": "1234", "type": "digital", "status": "active", "author": "Eduzz", "moderation": "new", "imageUrl": "https://cdn.eduzzcdn.com/xpto.jpg", "createdAt": "2018-03-20T19:57:44.357Z", "updatedAt": "2023-05-15T18:46:44.647Z", "payment": { "type": "oneTime", "price": { "currency": "BRL", "value": 100 }, "methods": { "bankslip": true, "pix": true, "card": true, "multipleCards": false } } } ``` -------------------------------- ### GET /alpaclass/v1/producer/teams Source: https://developers.eduzz.com/api/openapi Lists all schools belonging to the producer. ```APIDOC ## GET /alpaclass/v1/producer/teams ### Description Listar minhas escolas. ### Method GET ### Endpoint /alpaclass/v1/producer/teams ### Parameters #### Query Parameters - **sort** (string) - Optional - Ordenação ### Response #### Success Response (200) - **items** (array) - Lista de escolas #### Response Example { "items": [ { "id": "abcdef", "name": "Escola ABC", "url": "https://abcdef.alpaclass.com" } ] } ``` -------------------------------- ### List Customers (Shell) Source: https://developers.eduzz.com/reference/api/get-myeduzz-v1-customers Use this command to make a GET request to the Eduzz API to list customers. Ensure you have the necessary scopes. ```shell curl --request GET \ --url 'https://api.eduzz.com/myeduzz/v1/customers' \ --header 'Accept: application/json' ``` -------------------------------- ### GET /accounts/v1/me Source: https://developers.eduzz.com/docs/api/user-token Retrieves information about the authenticated user. ```APIDOC ## GET https://api.eduzz.com/accounts/v1/me ### Description Returns the account details of the user associated with the provided access token. ### Method GET ### Endpoint https://api.eduzz.com/accounts/v1/me ### Parameters #### Request Headers - **Authorization** (string) - Required - Must be in the format 'bearer {access_token}'. ### Response #### Success Response (200) - **id** (string) - User unique identifier. - **name** (string) - User full name. - **email** (string) - User email address. #### Response Example { "id": "00000000-0000-0000-0000-000000000000", "name": "Fulano da Silva", "email": "fulanodasilva@gmail.com" } ``` -------------------------------- ### List Courses in Delivery Response (JSON) Source: https://developers.eduzz.com/reference/api/get-alpaclass-v1-producer-teams-teamId-deliveries-deliveryId-courses Example JSON response when successfully retrieving the list of courses for a delivery. It includes pagination details and the list of courses with their IDs and names. ```json { "pages": 2, "page": 1, "itemsPerPage": 2, "totalItems": 3, "items": [ { "id": "NxTajk", "name": "Curso de Acupuntura" }, { "id": "zHTbOk", "name": "Curso de Podologia" } ] } ``` -------------------------------- ### Get Media Details using cURL Source: https://developers.eduzz.com/reference/api/get-safevideo-v1-medias-id Use this cURL command to make a GET request to the SafeVideo API to retrieve the details of a specific media item. Ensure you replace ':id' with the actual media identifier. The 'Accept' header should be set to 'application/json'. ```shell curl --request GET \ --url 'https://api.eduzz.com/safevideo/v1/medias/:id' \ --header 'Accept: application/json' ``` -------------------------------- ### Consultar Documentos Fiscais Source: https://developers.eduzz.com/reference/api/get-myeduzz-v1-financial-affiliate-fiscal-documents Utilize este comando para listar os documentos fiscais disponíveis para o afiliado autenticado. ```Shell curl --request GET \ --url 'https://api.eduzz.com/myeduzz/v1/financial/affiliate/fiscal-documents' \ --header 'Accept: application/json' ```