NAiOS IconNAiOS Logo
Contacto
Volver al catálogo

Codereadr

codereadr

CodeREADr is a mobile data collection and barcode scanning platform that enables businesses to create and manage services for data capture, validation, and reporting.

Developer ToolsWeb del proveedor
Acciones
22
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 (22)

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.

Collect Data With QuestionsCODEREADR_COLLECT_DATA_WITH_QUESTIONSAcción

Tool to configure data collection forms by adding custom questions. Use after creating a service to collect survey questions after each scan.

Parámetros de entrada

  • questionsobject[]Obligatorio

    List of custom questions to collect after each scan.

  • service_idstringObligatorio

    ID of the service/workflow to attach questions to.

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

Configure CodeREADr ConnectorCODEREADR_CONFIGURE_CONNECTORAcción

Helper to guide configuring the CodeREADr Connector for Google Sheets. There is no public API to programmatically create connector configurations. This tool validates your API connectivity (optional) and returns clear steps to proceed via the Google Sheets Add-on UI: https://www.codereadr.com/knowledgebase/codereadr-connector-add-on/

Parámetros de entrada

  • notestring

    Optional note to include in the resulting guidance message (for testing/logging).

  • include_legacy_probeboolean

    If true, also attempt a legacy section/action probe as a secondary check.

  • perform_connectivity_checkboolean

    If true, perform a lightweight API call to validate connectivity and API key.

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

Configure Direct Scan URL (DSU)CODEREADR_CONFIGURE_DSUAcción

Tool to configure a Direct Scan URL (DSU). Use after obtaining a valid service ID to set up scan callbacks. Use when you need to enable or update the DSU postback settings for a CodeREADr service.

Parámetros de entrada

  • service_idintegerObligatorio

    ID of the service to configure DSU for

  • postback_urlstringObligatoriouri

    Destination URL where scanners will post scan results (DSU callback)

  • scan_propertiesobject

    Key/value pairs to include with each scan for additional context or security

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

Configure CodeREADr Kiosk ModeCODEREADR_CONFIGURE_KIOSK_MODEAcción

Tool to enable and configure Kiosk Mode for unattended scanning. Use when setting up a dedicated scanning kiosk after service setup.

Parámetros de entrada

  • pinstringObligatorio

    Administrator PIN to lock/unlock Kiosk Mode

  • webifystringuri

    Custom URL for a branded portal; omit for default scan view

  • manual_inputboolean

    Allow manual data entry when true

  • stop_auto_nextboolean

    Prevent automatic progression to next scan when true

  • android_screen_pinningboolean

    Enable Android screen pinning when true

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

Configure Picking, Delivery & Receiving AppCODEREADR_CONFIGURE_PICKING_DELIVERY_APPAcción

Tool to configure the complete picking, delivery, and receiving workflow. Use when setting up scan workflow endpoints for an existing CodeREADr service.

Parámetros de entrada

  • questionsobject[]Obligatorio

    List of questions to collect during picking, delivery, and receiving steps.

  • service_idintegerObligatorio

    Identifier of the existing service to configure.

  • dsu_postback_urlstringObligatoriouri

    URL where direct scan results (DSU) are posted.

  • real_time_postback_urlstringObligatoriouri

    HTTPS endpoint to receive real-time scan callbacks.

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

Configure CodeREADr Postback URLCODEREADR_CONFIGURE_POSTBACK_URLAcción

Tool to configure a real-time postback URL for a CodeREADr service. Use when you need to set up or modify scan forwarding for an existing service.

Parámetros de entrada

  • service_idintegerObligatorio

    Identifier of the existing CodeREADr service to configure

  • postback_urlstringObligatoriouri

    HTTPS URL endpoint to receive real-time scan callbacks

  • scan_propertiesobject

    Additional key/value pairs to include with each scan; will be JSON-encoded automatically

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 CodeREADr ServiceCODEREADR_CREATE_SERVICEAcción

Tool to create a new workflow configuration (service) for scanning tasks. Use after obtaining a valid API key when registering a new Service.

Parámetros de entrada

  • service_idstring

    Optional ID to assign to the new service. If omitted, the server will generate one.

  • postback_urlstringuri

    Optional HTTPS endpoint to receive scan-postback (DSU) callbacks.

  • service_namestring

    Human-readable name for the service to create.

  • scan_propertiesobject

    Additional key/value properties to embed in each scan for added security. Will be JSON-encoded automatically.

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 CodeREADr DatabaseCODEREADR_DELETE_DATABASEAcción

Tool to delete an existing CodeREADr database. Use when you need to remove a database by its ID after confirming you no longer need its data. Example prompt: "Delete database with ID 123e4567-e89b-12d3-a456-426614174000".

Parámetros de entrada

  • database_idstringObligatorio

    The unique identifier of the database to delete (UUID)

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 DeviceCODEREADR_DELETE_DEVICEAcción

Tool to delete a device. Attempts the REST endpoint first and falls back to the legacy section/action API as needed. Parses JSON, XML, or text heuristically to avoid brittle failures.

Parámetros de entrada

  • device_idstringObligatorio

    Unique identifier of the device 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 Custom QuestionCODEREADR_DELETE_QUESTIONAcción

Tool to delete an existing custom question. Attempts the documented REST endpoint first; if unavailable, falls back to the legacy section/action API.

Parámetros de entrada

  • question_idstringObligatorio

    Identifier of the custom question to delete. Accepts numeric ID or string.

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 CodeREADr ServiceCODEREADR_DELETE_SERVICEAcción

Tool to delete an existing CodeREADr service. Use when you need to remove a service by its ID. Example prompt: "Delete service with ID 123e4567-e89b-12d3-a456-426614174000".

Parámetros de entrada

  • service_idstringObligatorio

    Identifier of the service to delete (UUID or numeric ID)

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 CodeREADr UserCODEREADR_DELETE_USERAcción

Tool to delete an existing user account. Attempts the REST endpoint first and falls back to the legacy section/action API if needed.

Parámetros de entrada

  • user_idstringObligatorio

    The unique identifier of the user 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

Generate Scan LinkCODEREADR_GENERATE_SCAN_LINKAcción

Tool to generate a CodeREADr scan link URI. Use when you want to open the CodeREADr app’s scanner pre-filled with a specific ID.

Parámetros de entrada

  • scan_idstringObligatorio

    The scan value to embed in the URI; this will pre-fill the scanner input.

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 Supported Barcode TypesCODEREADR_LIST_SUPPORTED_BARCODE_TYPESAcción

Tool to list supported barcode types. Use when you need to know which symbologies CodeREADr can scan.

Parámetros de entrada

  • limitinteger

    If provided, limit the number of returned items to this count (must be > 0).

  • only_barcode_typesboolean

    If True, filter the results to only known barcode symbologies.

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

Manage CodeREADr Response FieldsCODEREADR_MANAGE_RESPONSE_FIELDSAcción

Tool to create or update response fields returned with scan data. Use when customizing which fields to include in scan payloads.

Parámetros de entrada

  • fieldsstring[]Obligatorio

    List of response field keys to include in each scan payload.

  • service_idintegerObligatorio

    Identifier of the service to configure response fields 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

Retrieve CodeREADr DatabasesCODEREADR_RETRIEVE_DATABASESAcción

Tool to list all validation databases. Use when you need to fetch the configured scan-validation databases in your CodeREADr account after authentication.

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

Retrieve DevicesCODEREADR_RETRIEVE_DEVICESAcción

Tool to fetch registered devices. Use when you need to list all devices in your CodeREADr account.

Parámetros de entrada

  • pageinteger

    Pagination page number (optional)

  • searchstring

    Search term (optional)

  • statusstring

    Device status filter (optional)

  • per_pageinteger

    Items per page (optional)

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

Retrieve bulk scan recordsCODEREADR_RETRIEVE_SCANSAcción

Tool to retrieve bulk scan records. Use after specifying filters to fetch scan history in JSON or CSV for reporting.

Parámetros de entrada

  • end_datestringdate-time

    End timestamp for filtering scans (inclusive), ISO 8601 format.

  • templateinteger

    ID of CSV export template; required when return_type is 'csv'.

  • start_datestringdate-time

    Start timestamp for filtering scans (inclusive), ISO 8601 format.

  • return_typestringenum

    Format of returned data; 'json' for JSON payload, 'csv' for raw CSV.

    jsoncsv

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

Retrieve CodeREADr ServicesCODEREADR_RETRIEVE_SERVICESAcción

Tool to list all services. Use when you need to fetch configured services in your CodeREADr account after authentication.

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

Set Admin PINCODEREADR_SET_ADMIN_PINAcción

Tool to set or update the administrator PIN for Kiosk Mode. Use when updating the global or device/service-specific kiosk admin PIN.

Parámetros de entrada

  • pinstringObligatorio

    Administrator PIN to set for Kiosk Mode

  • device_idstring

    Optional device ID to apply the PIN to a specific device

  • service_idinteger

    Optional service ID to apply the PIN to a specific service

Parámetros de salida

  • dataobject

    Parsed JSON response from API if available

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

  • status_codeintegerObligatorio

    HTTP status code returned by the API

Update CodeREADr QuestionCODEREADR_UPDATE_QUESTIONAcción

Tool to update an existing custom question. Use when you need to modify question text or response options after creation. Use after confirming the question_id.

Parámetros de entrada

  • textstring

    New question text. If omitted, original text remains unchanged.

  • optionsobject[]

    List of response options to update or add.

  • question_idintegerObligatorio

    Unique identifier of the question to update.

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 CodeREADr ServiceCODEREADR_UPDATE_SERVICEAcción

Tool to update an existing service configuration. Use when you need to change settings of a CodeREADr service by ID.

Parámetros de entrada

  • actionstring

    Must be set to 'update'

  • api_keystringObligatorio

    Your CodeREADr API key

  • sectionstring

    Must be set to 'services'

  • auto_syncintegerenum

    Enable automatic sync of on-device scans/DB updates

    01
  • enableGPSintegerenum

    Include GPS with each scan (default 0)

    01
  • service_idintegerObligatorio

    The ID of the service to update

  • database_idstring

    ID of the database (if validation_method is database or ondevicedatabase)

  • descriptionstring

    New or updated description

  • symbologiesstring

    Comma-separated list of integer symbology IDs; omitting resets to default

  • postback_urlstringuri

    Destination URL where scans will be forwarded

  • service_namestring

    New service name

  • upload_emailstringemail

    Email to receive CSV after each upload

  • auto_next_scanintegerenum

    Control Auto-Next Scan feature; valid values 0-3

    0123
  • viewOtherScansintegerenum

    0=user sees own scans only; 1=sees all authorized users’ scans (default 1)

    01
  • block_db_searchintegerenum

    1=disallow DB lookup; 0=allow (default 0)

    01
  • duplicate_valueintegerenum

    Duplicate scan status for database/on-device database services (1=valid, 0=invalid)

    01
  • period_end_datestring

    Service end date (MM/DD/YYYY or YYYY-MM-DD)

  • period_end_timestring

    End time (hh:mm:ss or hh:mma)

  • auto_sync_up_urlstringuri

    Directly sync scans to your Postback URL when auto_sync is enabled

  • block_camera_scanintegerenum

    1=disallow camera scans; 0=allow (default 0)

    01
  • block_manual_scanintegerenum

    1=disallow manual entry; 0=allow (default 0)

    01
  • direct_lookup_urlstringuri

    URL to open when user taps Lookup; empty disables

  • period_start_datestring

    Service start date (MM/DD/YYYY or YYYY-MM-DD)

  • period_start_timestring

    Start time (hh:mm:ss or hh:mma)

  • auto_sync_down_urlintegerenum

    0=disable automatic DB downloads; 1=re-enable

    01
  • auto_sync_up_delayinteger

    Delay between upload attempts, in seconds

  • direct_history_urlstringuri

    URL to open when user taps History; empty disables

  • regex_scan_patternstring

    Regex pattern to match in scan value; used with regex_scan_replacement

  • upload_email_formatstringenum

    CSV format for emailed uploads

    regularproperties
  • auto_next_scan_delayinteger

    Delay before Auto-Next triggers, in seconds

  • auto_sync_down_delayinteger

    Delay between checks for DB updates, in seconds

  • device_duplicate_valueintegerenum

    Duplicate status for on-device duplicates (overridden if duplicate_value=0)

    01
  • postback_receiver_onlyintegerenum

    1 if postback_url can only receive; 0 if it can receive and respond

    01
  • regex_response_patternstring

    Regex pattern to match in scan response; used with regex_response_replacement

  • regex_scan_replacementstring

    Replacement value for regex_scan_pattern; used together

  • postback_uploaded_scansintegerenum

    Enable postback of each uploaded on-device scan (requires postback_url)

    01
  • postback_real_time_scansintegerenum

    Enable real-time postback of each online scan (requires postback_url)

    01
  • regex_response_replacementstring

    Replacement value for regex_response_pattern; used together

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