NAiOS IconNAiOS Logo
Contacto
Volver al catálogo

Accredible certificates

accredible_certificates

Accredible Certificates is a platform that enables organizations to create, manage, and distribute digital certificates, open badges, and blockchain credentials.

EducationWeb del proveedor
Acciones
14
Triggers
0
Autenticación
—
OAuth gestionado
No
Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (14)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Bulk Create Credentials (V2)ACCREDIBLE_CERTIFICATES_BULK_CREATE_CREDENTIALS_V2Acción

Tool to bulk create credentials. use when batching up to 30 credentials in one call; supports multi-status (207) responses.

Parámetros de entrada

  • credentialsobject[]Obligatorio

    List of up to 30 credentials to create in one batch

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Clone GroupACCREDIBLE_CERTIFICATES_CLONE_GROUPAcción

Tool to clone an existing group. use after confirming the source group exists and you need a copy with optional overrides.

Parámetros de entrada

  • namestring

    Override name of the cloned group (prefixed with 'Copy' if omitted)

  • group_idintegerObligatorio

    ID of the group to clone

  • languagestringenum

    Override language code for the group

    enesviptjafrdanlfinonbro+9
  • meta_dataobject

    Override arbitrary metadata for the group

  • attach_pdfboolean

    Override PDF attachment setting when notifying recipients

  • blockchainboolean

    Override blockchain recording setting

  • signup_urlanyuri

    Override signup URL for course enrollment

  • auto_expiryinteger

    Override credential auto-expiry in years; ignored if <=0

  • course_linkanyuri

    Override URL for the course information page

  • course_namestring

    Override course or achievement name visible to the recipient

  • badge_design_idinteger

    Override badge design ID

  • signup_url_showboolean

    Override showing signup URL

  • course_link_showboolean

    Override showing course link

  • learning_outcomesstring[]

    Override list of learning outcomes

  • primary_design_idinteger

    Override primary design ID

  • skill_category_idinteger

    Override skill category association

  • course_descriptionstring

    Override description visible to the recipient

  • certificate_design_idinteger

    Override certificate design ID

  • organization_link_showboolean

    Override showing organization link

  • allow_duplicate_credentialsboolean

    Override allowing duplicate credentials per email

  • generate_private_credentialboolean

    Override private credential default: true, false, or null to inherit

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create CollectionACCREDIBLE_CERTIFICATES_CREATE_COLLECTIONAcción

Tool to create a new collection. use when you need a curated set of groups.

Parámetros de entrada

  • namestringObligatorio

    Name of the collection

  • publicboolean

    Whether the collection is public

  • descriptionstring

    Description of the collection

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Evidence ItemACCREDIBLE_CERTIFICATES_CREATE_EVIDENCE_ITEMAcción

Tool to create a new evidence item for a credential. use after confirming credential id.

Parámetros de entrada

  • urlanyuri

    URL of the item when category is url or video

  • fileanyuri

    File URL when category is file

  • previewanyuri

    Override preview image URL for URL category

  • categorystringObligatorioenum

    Type of evidence item, dictates its display

    fileurlvideogradetranscript
  • positioninteger

    Position index of the evidence item on the credential (0 = first)

  • descriptionstringObligatorio

    Title text for the evidence item displayed on the credential

  • credential_idstringObligatorio

    Global ID of the credential to attach the evidence item to

  • string_objectstring

    String data for grade or transcript categories, e.g., '83'

  • custom_insightstring

    Override auto-generated insight text below the evidence item

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create GroupACCREDIBLE_CERTIFICATES_CREATE_GROUPAcción

Tool to create a new group. use after gathering all group details.

Parámetros de entrada

  • namestringObligatorio

    Name of the group (internal reference, not shown to the recipient)

  • languagestringenum

    Language code for the group

    enesviptjafrdanlfinonbro+9
  • meta_dataobject

    Arbitrary string key-value metadata for this group

  • attach_pdfboolean

    Attach credential PDF to notification email

  • blockchainboolean

    Record credentials on blockchain

  • signup_urlanyuri

    Signup URL for course enrollment

  • auto_expiryinteger

    Years until auto-expiry of credential; ignored if <=0

  • collectionsobject[]

    List of collection objects with 'id' field

  • course_linkanyuri

    URL for course information page

  • course_namestringObligatorio

    Course or achievement name visible to the recipient

  • department_idinteger

    Department ID for the group; defaults to org default

  • badge_design_idinteger

    Badge design ID to render credentials

  • signup_url_showboolean

    Display signup URL: true/false or null to inherit

  • course_link_showboolean

    Display course link: true/false or null to inherit

  • learning_outcomesstring[]

    Learning outcomes list for this group

  • primary_design_idinteger

    Primary design ID to render credentials

  • skill_category_idinteger

    Skill category ID to associate

  • course_descriptionstringObligatorio

    Description of the course or achievement visible to the recipient

  • certificate_design_idinteger

    Certificate design ID to render credentials

  • organization_link_showboolean

    Display organization link: true/false or null to inherit

  • allow_duplicate_credentialsboolean

    Allow duplicate credentials per email: true/false

  • generate_private_credentialboolean

    Override default private credential setting: true/false or null to inherit

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete CredentialACCREDIBLE_CERTIFICATES_DELETE_CREDENTIALAcción

Tool to delete a credential. use after confirming you want to permanently remove an existing credential. executes delete on /credentials/{credential id} endpoint and returns status code.

Parámetros de entrada

  • credential_idstringObligatorio

    The unique ID of the credential to delete

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete GroupACCREDIBLE_CERTIFICATES_DELETE_GROUPAcción

Tool to delete a group. use after confirming no credentials remain and when you need to permanently remove the group.

Parámetros de entrada

  • group_idintegerObligatorio

    Numeric ID of the group to delete.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete ReferenceACCREDIBLE_CERTIFICATES_DELETE_REFERENCEAcción

Tool to delete a specific reference by id. use after confirming both credential id and reference id. example: "delete reference 1234 from credential 'abc123'."

Parámetros de entrada

  • reference_idintegerObligatorio

    ID of the Reference to delete (must be positive).

  • credential_idstringObligatorio

    ID of the Credential to remove the reference from. May be numeric or string-formatted.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Generate PDFs for CredentialsACCREDIBLE_CERTIFICATES_GENERATE_PD_FS_FOR_CREDENTIALSAcción

Tool to generate pdfs for multiple credentials. use when you need to batch-download a zip archive of certificate pdfs for a list of published credential ids. example: "generate pdfs for credentials [10000005, 10272642]".

Parámetros de entrada

  • credential_idsstring[]Obligatorio

    List of published credential IDs to generate PDFs for

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List TemplatesACCREDIBLE_CERTIFICATES_LIST_TEMPLATESAcción

Tool to retrieve a list of all templates. use after authentication to fetch paginated certificate templates.

Parámetros de entrada

  • pageinteger

    Page number of results to fetch

  • per_pageinteger

    Number of templates per page

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Search CollectionsACCREDIBLE_CERTIFICATES_SEARCH_COLLECTIONSAcción

Tool to search for collections. use when you need to filter collections by ids, name, or public flag and paginate through results. e.g., "search for public collections named 'abc' on page 2."

Parámetros de entrada

  • metaobject

    Build pagination into your search.

  • sortobject

    Controls the order in which results are returned.

  • queryobjectObligatorio

    Filtering criteria for collections

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update GroupACCREDIBLE_CERTIFICATES_UPDATE_GROUPAcción

Tool to update an existing group. use when you need to modify group details after fetching its current data.

Parámetros de entrada

  • namestring

    Name of the group (for internal reference, not shown to the recipient)

  • group_idintegerObligatorio

    ID of the group to update

  • languagestringenum

    Language for the group

    enesviptjafrdanlfinonbro+9
  • meta_dataobject

    Arbitrary metadata to associate with this group

  • attach_pdfboolean

    Whether to attach the Credential PDF to the email when recipient is informed

  • blockchainboolean

    Enable or disable recording of these Credentials on a Blockchain

  • signup_urlanyuri

    URL for recipients to sign up for the course

  • auto_expiryinteger

    Number of years from issue date after which the credential will automatically expire; ignored if <=0

  • collectionsobject[]

    List of collections to assign; each object needs an 'id' field

  • course_linkanyuri

    URL to the web page with information related to this group

  • course_namestring

    Name of the course or achievement visible to the recipient

  • department_idinteger

    Department that the group belongs to; if not defined, it defaults to the organization's default department

  • badge_design_idinteger

    Badge Design ID which the group will use to display credentials

  • signup_url_showboolean

    Show or hide the signup URL; true to show, false to hide, null to inherit default

  • course_link_showboolean

    Show or hide the course link; true to show, false to hide, null to inherit default

  • learning_outcomesstring[]

    List of learning outcomes for this group

  • primary_design_idinteger

    Primary Design ID which the group will use to display credentials

  • skill_category_idinteger

    ID of the skill category to associate with this group

  • course_descriptionstring

    Description of the course or achievement visible to the recipient

  • certificate_design_idinteger

    Certificate Design ID which the group will use to display credentials

  • organization_link_showboolean

    Show or hide link to the organization's homepage; true to show, false to hide, null to inherit default

  • allow_duplicate_credentialsboolean

    Whether an email address can receive more than one credential in this group; defaults to false

  • generate_private_credentialboolean

    Override department default for private credentials; true or false to override, null to inherit department setting

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update ReferenceACCREDIBLE_CERTIFICATES_UPDATE_REFERENCEAcción

Tool to update a reference by id. use when you need to modify a reference's details for a credential. use after retrieving the reference id to change comments or relationship.

Parámetros de entrada

  • referenceobjectObligatorio

    Object containing only the reference fields to modify.

  • reference_idintegerObligatorio

    ID of the reference to update.

  • credential_idstringObligatorio

    ID of the credential containing the reference.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

View All Skill CategoriesACCREDIBLE_CERTIFICATES_VIEW_ALL_SKILL_CATEGORIESAcción

Tool to retrieve all skill categories. use when you need to list all available skill categories (e.g., to link them to groups).

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not