logo
Documentation Powered by ReDoc

Dynamicore API (1.0.0)

Download OpenAPI specification:Download

E-mail: support@dynamicore.io URL: https://dynamicore.io/ License: Apache 2.0 Terms of Service

This is an example API to demonstrate features of the OpenAPI specification.

Introduction

Welcome to the DynamiCore API! You can use our API to access DynamiCore API endpoints, which can get information on various accounts in our database.

We have language bindings in Shell, Ruby, Python, and JavaScript! You can view code examples in the dark area to the right, and you can switch the programming language of the examples with the tabs in the top right.

OpenAPI/Swagger format.

It also demonstrates features of the create-openapi-repo tool and

the Redoc documentation engine. Beyond the standard OpenAPI syntax, we use a few

vendor extensions.

Authentication

main_auth

Security Scheme Type OAuth2
implicit OAuth Flow
Authorization URL: http://example.com/api/oauth/dialog
Scopes:
  • read:users -

    read users info

  • write:users -

    modify or remove users

api_key

Security Scheme Type API Key
Header parameter name: api_key

basic_auth

Security Scheme Type HTTP
HTTP Authorization Scheme basic

Authentication

Message hash key authentication (HMAC) is a specific construct for calculating a message authentication code, which involves a cryptographic hash function in combination with a cryptographic secret key.

Like any MAC, it can be used to simultaneously verify data integrity and authentication of a message. The SHA-512 cryptographic hash function is used.

The hash function breaks a message into a block of a fixed size and iterates over them with a compression function. The cryptographic strength of HMAC depends on the cryptographic power of the underlying hash function, the size of its hash output and quality of the key.

Types

Types of clients

This endpoint is used to create client types

HTTP Request

POST [https://api.dynamicore.io/v1/clients/types]

Parameters

Parameter Required Type Description Example
name Y String Name of client type Persona Fisica
description O String Description of client type Template para registro de personas fisicas en SOFOM
pii[lastname] Y String Lastname of client Lopez
Authorizations:
api_keybasic_auth
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "status": "success",
  • "message": {
    }
}

Types of products

This endpoint is used to create products types

HTTP Request

POST [https://api.dynamicore.io/v1/products/types]

Parameters

Parameter Required Type Description Example
name Y String Name of client type Persona Fisica
description O String Description of client type Template para registro de personas fisicas en SOFOM
pii[lastname] Y String Lastname of client Lopez
Authorizations:
api_keybasic_auth
Request Body schema: application/json

Echo payload

object

Responses

Request samples

Content type
application/json
{
  • "status": "success",
  • "message": {
    }
}

Catalogs

Catalog of Type of Client

This endpoint retrieves a catalog of client templates.

HTTP Request

GET [https://api.dynamicore.io/v1/catalog/fields/client]

Authorizations:
main_authapi_key
Request Body schema: application/json

Echo payload

object

Responses

Request samples

Content type
application/json
{
  • "status": "success",
  • "message": {
    }
}

Catalog of product templates

This endpoint retrieves a catalog of product templates.

HTTP Request

GET [https://api.dynamicore.io/v1/catalog/fields/product]

Authorizations:
main_authapi_key
Request Body schema: application/json

Echo payload

object

Responses

Request samples

Content type
application/json
{
  • "status": "success",
  • "message": {
    }
}

Clients

Create client

This endpoint is used to create client.

HTTP Request

POST [https://api.dynamicore.io/private/clients]

Parameters

Parameter Required Type Description Example
client_type Y String Type of client 17
pii[firstname] Y String Firstname of client Rafael
pii[lastname] Y String Lastname of client Lopez
pii[rfc] Y String RFC of client RALO101086GT4
pii[email] Y String Email of client email@google.com
Authorizations:
main_authapi_key
Request Body schema: application/json

Echo payload

object

Responses

Request samples

Content type
application/json
{
  • "status": "success",
  • "message": {
    }
}

Update client

This endpoint is used to update client.

HTTP Request

PUT [https://api.dynamicore.io/private/clients]

Parameters

Parameter Required Type Description Example
id Y String ID Clients 1
pii[firstname] Y String Firstname of client Rafael
pii[lastname] Y String Lastname of client Lopez
pii[rfc] Y String RFC of client RALO101086GT4
pii[email] Y String Email of client email@google.com
Authorizations:
main_authapi_key
Request Body schema: application/json

Echo payload

object

Responses

Request samples

Content type
application/json
{
  • "status": "success",
  • "message": {
    }
}

List of clients

This endpoint is used to list of clients.

HTTP Request

GET [https://api.dynamicore.io/private/clients]

Parameters

Parameter Required Type Description Example
id O String Client Identifier 1
Authorizations:
main_authapi_key
Request Body schema: application/json

Echo payload

object

Responses

Request samples

Content type
application/json
{
  • "status": "success",
  • "message": {
    }
}

Upload documents

This endpoint is used to upload documents to client.

HTTP Request

POST [https://api.dynamicore.io/files/users/upload/:client_id/:pii[acta_constitutiva]]

FormData Parameters

Parameter Required Type Description Example
file Y Array of files acta_constitutiva.pdf, rfc.pdf
Authorizations:
main_authapi_key
Request Body schema: application/json

Echo payload

object

Responses

Request samples

Content type
application/json
{
  • "status": "success",
  • "message": {
    }
}

Get SAT

This endpoint is used to get SAT data.

HTTP Request

GET [https://api.dynamicore.io/v1/clients/:client_id/sat]

Authorizations:
main_authapi_key
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "status": "success",
  • "message": {
    }
}

Get Credit Store

This endpoint is used to get Credit Score.

HTTP Request

GET [https://api.dynamicore.io/v1/clients/:client_id/score]

Authorizations:
main_authapi_key
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "status": "success",
  • "message": {
    }
}

Accounts

Create Account

This endpoint is used to create account.

HTTP Request

POST [https://api.dynamicore.io/v1/accounts]

Parameters

Parameter Required Type Description Example
client_id Y String Client Identifier 1
product Y String Product Identifier 6
enabled Y String Enabled of product. . Values: Active -> 1, Inactive -> 0 1
currency Y String Product currency 484
Authorizations:
main_authapi_key
Request Body schema: application/json

Echo payload

object

Responses

Request samples

Content type
application/json
{
  • "status": "success",
  • "message": {
    }
}

Customer Account

This endpoint is used to customer accounts.

HTTP Request

GET [https://api.dynamicore.io/v1/accounts]

Query Parameters

Parameter Required Type Description Example
id Y String Account Identifier 1
client_id Y String Client Identifier 1
Authorizations:
main_authapi_key
Request Body schema: application/json

Echo payload

object

Responses

Request samples

Content type
application/json
{
  • "status": "success",
  • "message": {
    }
}

Account transactions

This endpoint is used to get account transactions.

HTTP Request

GET [https://api.dynamicore.io/v1/accounts/:account_id/transactions]

Authorizations:
main_authapi_key
Request Body schema: application/json

Echo payload

object

Responses

Request samples

Content type
application/json
{
  • "status": "success",
  • "message": {
    }
}

Account payments

This endpoint is used to get account payments.

HTTP Request

GET [https://api.dynamicore.io/v1/accounts/:account_id/payments]

Authorizations:
main_authapi_key
Request Body schema: application/json

Echo payload

object

Responses

Request samples

Content type
application/json
{
  • "status": "success",
  • "message": {
    }
}

MARKETPLACE

SAT

Load Keys

This endpoint is used to keys for SAT consult.

HTTP Request

POST [https://api.dynamicore.io/internal/sat/sat_key]

Parameters

Parameter Required Type Description Example
client Y Number Client Identifier 1
type Y String Type of keys for SAT consult. Values: ciec(You need to send the pas parameter), efirma(You need to send the pas, key and cer parameters) ciec
pass Y String Password of keys
key O String Private key. File of type key in Base64 file.key
cer O String Certificate. File of type cer in Base64 file.cer
Authorizations:
main_authapi_key
Request Body schema: application/json

Echo payload

object

Responses

Request samples

Content type
application/json
{
  • "status": "success",
  • "message": {
    }
}

Sync Data

This endpoint is used to sync of the SAT data. Its execute is async to obtain data you should used the endpoint Get Data.

HTTP Request

POST [https://api.dynamicore.io/internal/sat/sat_key]

Parameters

Parameter Required Type Description Example
client Y Number Client Identifier 1
start Y String Start of date to obtain data 2021-01-01
end Y String End of date to obtain data 2021-11-31
Authorizations:
main_authapi_key
Request Body schema: application/json

Echo payload

object

Responses

Request samples

Content type
application/json
{
  • "status": "success",
  • "message": {
    }
}

Get Data

This endpoint is used to get data of SAT.

HTTP Request

GET [https://api.dynamicore.io/private/sat/data]

Query Parameters

Parameter Required Type Description Example
client Y Number Client Identifier 1
start O String Start of date to obtain data 2021-01-01
end O String End of date to obtain data 2021-11-31
limit O String Limit query results 50
page O String Paginate query results 1
Authorizations:
main_authapi_key
Request Body schema: application/json

Echo payload

object

Responses

Request samples

Content type
application/json
{
  • "status": "success",
  • "message": {
    }
}

Mifiel

Create Document

You must first upload the document here. So that later it generates the document to sign.

This endpoint is used to create a document that will be signed.

To sign the document you must load the widget.

HTTP Request

POST [https://api.dynamicore.io/marketplace/apps/mifiel/documents]

Query Parameters

Parameter Required Type Description Example
id Y Number id of client 424
type Y String type client
field Y String field acceptance_bc
signatories Y Array of objects A list of Signatory Object [{"email":"","name": "","tax_id": ""}]
external_id O String Your unique identifier Mifiel-0000000000000001
day_to_expire O Integer Number of days the document expires 1
send_invites O boolean Set True if you want Mifiel to email invitations to attendees. If your participants will sign in the widget embedded within your application send False. "true"
remind_every O Integer Signing reminders will be sent to those who have not signed (if send_mail is enabled) 0
viewers O Array of objects List of emails from whom they will receive notifications (if enabled) every time someone signs and they will receive a copy of the signed document. [{"email":"","name": ""}]
Authorizations:
main_authapi_key
Request Body schema: application/json

Echo payload

object

Responses

Request samples

Content type
application/json
{
  • "status": "success",
  • "message": {
    }
}

Widget

The signing widget is a tool that you can embed in your application so that stakeholders sign or approve documents in an iframe without leaving your website.

Note: It is not necessary for stakeholders to be registered in Mifiel In order to sign or approve a document.

To integrate it in your application, copy this and paste it before closing the </ body > tag in your page.

Each signer or reviewer of a document has a unique identifier to access the document. Make sure to insert the stakeholder’s widget id (which you received when creating the document) so that the stakeholders visualize the correct document in the signing widget.

Note: If not the html code block click here!.

Authorizations:
main_authapi_key

Get Document

This endpoint is used to get Document data.

HTTP Request

GET [https://api.dynamicore.io/marketplace/apps/mifiel/documents/:id]

Authorizations:
main_authapi_key
Request Body schema: application/json

Echo payload

object

Responses

Request samples

Content type
application/json
{
  • "status": "success",
  • "message": {
    }
}

Conekta

Create Orders

This endpoint is used to create order.

HTTP Request

POST [https://api.dynamicore.io/marketplace/apps/conekta/order/new_order]

Query Parameters

Parameter Required Type Description Example
account Y Integer Account 1
operation O Integer operation 184
customer_info Y Object Object with customer information. Telephone and email is optional {"name": "Demo", "phone":"", "email":""}
items Y Object Object with item information. The price per unit expressed in cents. { "name": "Box of Cohiba S1s", "unit_price": 1000, "quantity": 1 }
payment_method O Object Object with payment method information { "type": "oxxo_cash" }
config O Object config 0
Authorizations:
main_authapi_key
Request Body schema: application/json

Echo payload

object

Responses

Request samples

Content type
application/json
{
  • "status": "success",
  • "message": {
    }
}

Get Order

This endpoint is used to get Order data.

HTTP Request

GET [https://api.dynamicore.io/marketplace/apps/conekta/order/get_order/:id]

Authorizations:
main_authapi_key
Request Body schema: application/json

Echo payload

object

Responses

Request samples

Content type
application/json
{
  • "status": "success",
  • "message": {
    }
}

Get Reference Pending

This endpoint is used to get pending reference data.

HTTP Request

GET [https://api.dynamicore.io/marketplace/apps/conekta/order/get_order_pending/:account]

Authorizations:
main_authapi_key
Request Body schema: application/json

Echo payload

object

Responses

Request samples

Content type
application/json
{
  • "status": "success",
  • "message": {
    }
}

CardPayments

Create Client

This endpoint is used to create clients.

HTTP Request

POST [https://api.dynamicore.io/marketplace/apps/dynamicardpay/v2/clients]

Parameters

Parameter Required Type Description Example
first_name Y String Client First name "Test"
last_name Y String Client Last name "Open Pass 5"
address_one Y String Street + number "Av naciones"
city Y String Address City "Mexico"
state Y String Address State "Mexico"
zipcode Y String Address zipcode "55717"
email Y String Client email "y.g@dynamicore.io"
country Y String Address country "mexico"
date_of_birth Y String Client date of birth "03/05"
last4ssn O String Last 4 of SSN "1234",
phone Y String Client phone "5500223355"
username O String Client Internal Identifier "yozgart"
Authorizations:
main_authapi_key
Request Body schema: application/json

Echo payload

object

Responses

Request samples

Content type
application/json
{
  • "status": "success",
  • "message": {
    }
}

Get Client

This endpoint is used to get Order data.

HTTP Request

GET [https://api.dynamicore.io/marketplace/apps/dynamicardpay/v2/clients?id={client_id}]

Query Parameters

Parameter Required Type Description Example
client_id Y String Id of a previous client 9ec838c8-162f-4871-a31e-35005dc24057
Authorizations:
main_authapi_key
Request Body schema: application/json

Echo payload

object

Responses

Request samples

Content type
application/json
{
  • "status": "success",
  • "message": {
    }
}

Tokenize

Por la seguridad de los datos de tu tarjeta la información debe ser procesada a traves de un token alfanumerico generado por DYNAMICORE. Para generar este token nuestra API cuenta con dos metodos disponibles: el iframe de tokenizado o un endpoint de API.

Tokenizado de tarjeta con iframe

El iframe es una solución que permite a los comercios procesar pagos con tarjeta de manera segura sin necesidad de almacenar los datos de la tarjeta en sus servidores, esta implementación permite al comercio cumplir con los estándares de seguridad sin necesidad de realizar una integración compleja.

Para integrar el iframe, copia y pega el siguiente código en un archivo con extensión .html y sustituye las variables KEY ID y PUBLIC KEY por las llaves proporcionadas por DYNAMICORE. Al abrir este archivo HTML en el navegador se crea un formulario que permite procesar los datos de la tarjeta de manera segura.

<!DOCTYPE html>
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <script src="https://d132t6c8viujz9.cloudfront.net"></script>
    <title>DYNAMICORE TOKENIZE</title>
    <script>
        const config = {
            targetIFrame: 'mainDiv',                      
            keyId: `{KEY_ID}`,
            publicKey: `{PUBLIC_KEY}`,
        }
    </script>
</head>
<body>
    <div style="width: 100%; display: grid; place-items: center;" id="mainBody"><iframe id="mainDiv" style="border: none;"></iframe></div> 
</body>
</html>
Authorizations:
main_authapi_key

Assign card to client

This endpoint is used to assign a card token to client as a payment method.

HTTP Request

POST [https://api.dynamicore.io/marketplace/apps/dynamicardpay/v2/card/assignToCustomer]

Parameters

Parameter Required Type Description Example
customer_id Y String Client id 6de6ab83-5561-4891-96c5-11becc38b835
token_id Y String Token id 003476fb-2491-48de-a2b3-19a4187e2bc6
Authorizations:
main_authapi_key
Request Body schema: application/json

Echo payload

object

Responses

Request samples

Content type
application/json
{
  • "status": "success",
  • "message": {
    }
}

Get Token

This endpoint is used to get token data.

HTTP Request

GET [https://api.dynamicore.io/marketplace/apps/dynamicardpay/v2/card/token?id={token_id}]

Query Parameters

Parameter Required Type Description Example
token_id Y String Id of a previous token 9ec838c8-162f-4871-a31e-35005dc24057
Authorizations:
main_authapi_key
Request Body schema: application/json

Echo payload

object

Responses

Request samples

Content type
application/json
{
  • "status": "success",
  • "message": {
    }
}

List Payment Methods

This endpoint is used to get the list of client payment methods.

HTTP Request

GET [https://api.dynamicore.io/marketplace/apps/dynamicardpay/v2/payment_methods/list?customer_id={client_id}]

Query Parameters

Parameter Required Type Description Example
customer_id Y String Id of a previous client 9ec838c8-162f-4871-a31e-35005dc24057
Authorizations:
main_authapi_key
Request Body schema: application/json

Echo payload

object

Responses

Request samples

Content type
application/json
{
  • "status": "success",
  • "message": [
    ]
}

Transaction

This endpoint is used to assign a card token to client as a payment method.

HTTP Request

POST [https://api.dynamicore.io/marketplace/apps/dynamicardpay/v2/transactions/ccTransaction]

Parameters

Parameter Required Type Description Example
customer_id Y String Client id 6de6ab83-5561-4891-96c5-11becc38b835
payment_method Y String Id of previous Payment Method 003476fb-2491-48de-a2b3-19a4187e2bc6
amount Y Number Transaction amount 0.01
Authorizations:
main_authapi_key
Request Body schema: application/json

Echo payload

object

Responses

Request samples

Content type
application/json
{
  • "status": "success",
  • "message": {
    }
}

Get Transaction

This endpoint is used to get transaction by id.

HTTP Request

GET [https://api.dynamicore.io/marketplace/apps/dynamicardpay/v2/main/transactions?id={transaction_id}]

Query Parameters

Parameter Required Type Description Example
transaction_id Y String Id of a previous transaction trs_9ec838c8-162f-4871-a31e-35005dc24057_sec_1000000752
Authorizations:
main_authapi_key
Request Body schema: application/json

Echo payload

object

Responses

Request samples

Content type
application/json
{
  • "status": "success",
  • "message": {
    }
}

Errors

'DynamiCore uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a charge failed, etc.). Codes in the 5xx range indicate an error with Ictineo servers (these are rare).'

HTTP STATUS CODE SUMMARY

Error Code Meaning
401 Unauthorized
403 Forbidden
404 Not Found - The resource you are trying to access cannot be found
409 Conflict - A conflict occurred on the server while processing your request
500 Internal Server Error - A serious error occurred on the server, please try again later

Campaigns

Get Campaigns

This endpoint is used to get campaigns.

HTTP Request GET [https://api.dynamicore.io/private/campaign]

Authorizations:
main_authapi_key
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "status": "success",
  • "message": {
    }
}

Eval Campaign

This endpoint is used to get eval campaigns.

HTTP Request GET [https://api.dynamicore.io/private/campaign]

Authorizations:
main_authapi_key
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "status": "success",
  • "message": {
    }
}

Get Campaigns Types

This endpoint is used to get types of campaigns.

HTTP Request GET [https://api.dynamicore.io/private/campaign/types]

Authorizations:
main_authapi_key
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "status": "success",
  • "message": {
    }
}

Create Campaign

This endpoint is used to create campaigns.

HTTP Request POST [https://api.dynamicore.io//private/campaign]

Parameters

Parameter Required Type Description Example
id Y Number Id of campaign 175
name Y String Name of campaign Notificación de pago - 3 dias antes de pago
type Y Number Type of campaign 2
company Y Number Number of campaign 3027
enabled Y String Status of campaign 2
description Y String Description of campaign 3 dias antes de pago
Authorizations:
main_authapi_key
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "id": "175",
  • "name": "Notificación de pago - 3 dias antes de pago",
  • "type": "2",
  • "company": "3027",
  • "enabled": "1",
  • "description": "3 dias antes de pago"
}

Update Campaign

This endpoint is used to update a campaign.

HTTP Request PUT [https://api.dynamicore.io//private/campaign]

Parameters

Parameter Required Type Description Example
id Y Number Id of campaign 175
name Y String Name of campaign Notificación de pago - 3 dias antes de pago
type Y Number Type of campaign 2
company Y Number Number of campaign 3027
enabled Y String Status of campaign 2
description Y String Description of campaign 3 dias antes de pago
Authorizations:
main_authapi_key
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "id": "175",
  • "name": "Notificación de pago - 3 dias antes de pago",
  • "type": "2",
  • "company": "3027",
  • "enabled": "1",
  • "description": "3 dias antes de pago"
}

Delete Campaign

This endpoint is used to delete campaign.

HTTP Request

DELETE [https://api.dynamicore.io/private/campaign?id=1]

Parameters

Parameter Required Type Description Example
id Y Number ID Clients 1
Authorizations:
main_authapi_key
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "status": "success",
  • "message": {
    }
}

Users

Get Users

This endpoint is used to get users.

HTTP Request GET [https://api.dynamicore.io/private/users]

Authorizations:
main_authapi_key
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "status": "success",
  • "message": {
    }
}

New User

This endpoint is used to create users.

HTTP Request

POST [https://api.dynamicore.io/users/create]

Parameters

Parameter Required Type Description Example
email Y String Email of user example1@gmail.com
password Y String Password of user Password123
Authorizations:
main_authapi_key
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "status": "success",
  • "message": {
    }
}

Get Binnacle

This endpoint is used to get binnacle.

HTTP Request GET [https://api.dynamicore.io/private/users/binnacle]

Authorizations:
main_authapi_key
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "status": "success",
  • "message": {
    }
}

Create Owner

This endpoint is used to create owner.

HTTP Request

POST [https://api.dynamicore.io/users/owner]

Parameters

Parameter Required Type Description Example
email Y String Email of user example1@gmail.com
Authorizations:
main_authapi_key
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "status": "success",
  • "message": {
    }
}

Role User Client

This endpoint is used to create role users client.

HTTP Request

POST [https://api.dynamicore.io/users/add]

Parameters

Parameter Required Type Description Example
email Y String Email of user example1@gmail.com
role Y Object Role of user {"Version": 1, "Statement": [{"Action": [":"], "Effect": "Allow", "Resource": "dcore:::*"}]}
Authorizations:
main_authapi_key
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "status": "success",
  • "message": {
    }
}

Company

Get Contrab

This endpoint is used to get Contrab.

HTTP Request

GET [https://api.dynamicore.io/private/crontab]

Authorizations:
main_authapi_key
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "status": "success",
  • "message": {
    }
}

Create Contrab

This endpoint is used to create Contrab.

HTTP Request

POST [https://api.dynamicore.io/private/crontab]

Parameters

Parameter Required Type Description Example
company Y Number Id of company 17
cron Y String Type */1 * * * *
command Y String Comdand python3 /usr/src/app/start.py >> /usr/src/app/myjob.log 2>&1
user_role Y String Id Role of User ssdf234
node Y Number Node 12
Authorizations:
main_authapi_key
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "status": "success",
  • "message": {
    }
}

Update Contrab

This endpoint is used to update Contrab.

HTTP Request

PUT [https://api.dynamicore.io/private/crontab]

Parameters

Parameter Required Type Description Example
company Y Number Id of company 17
cron Y String Type */1 * * * *
command Y String Comdand python3 /usr/src/app/start.py >> /usr/src/app/myjob.log 2>&1
user_role Y String Id Role of User ssdf234
node Y Number Node 12
Authorizations:
main_authapi_key
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "status": "success",
  • "message": {
    }
}

Update Company

This endpoint is used to create Company.

HTTP Request

PUT [https://api.dynamicore.io/private/company]

Parameters

Parameter Required Type Description Example
id Y Number Id of company 17
name Y String Name of Company My Company
time_zone Y Time Time 10:00:00
date_format Y Date Date 2022-09-09
street_address Y String Adrees of Company 45 Avenue
city Y String City of company Orlando
zipcode Y Number Zip Code of Company 03100
state Y String State of Company Florida
contry Y String Country of Company United States
email Y Email Email of contact example@gmail.com
logo Y url Url python3 /usr/src/app/start.py >> /usr/src/app/myjob.log 2>&1
icon Y url Url
tax_id Y Number Id 12
Authorizations:
main_authapi_key
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "status": "success",
  • "message": {
    }
}

Products

Get Products

This endpoint is used to get products.

HTTP Request

GET [https://api.dynamicore.io/private/products]

Authorizations:
main_authapi_key
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "status": "success",
  • "message": {
    }
}

Create Products

This endpoint is used to create products.

HTTP Request

POST [https://api.dynamicore.io/private/products]

Parameters

Parameter Required Type Description Example
id Y Number Id of product 1
name Y String Name of Product CC077
group Y Number Id of group 17
company Y String Id of company 17
enabled Y Boolean Type of client true
description Y String Description of product Example Description
product_type Y String Product type 43
Authorizations:
main_authapi_key
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "status": "success",
  • "message": {
    }
}

Update Products

This endpoint is used to update products.

HTTP Request

PUT [https://api.dynamicore.io/private/products]

Parameters

Parameter Required Type Description Example
id Y Number Id of product 1
name Y String Name of Product CC077
group Y Number Id of group 17
company Y String Id of company 17
enabled Y Boolean Type of client true
description Y String Description of product Example Description
product_type Y String Product type 43
Authorizations:
main_authapi_key
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "status": "success",
  • "message": {
    }
}

Get Products types

This endpoint is used to get products types.

HTTP Request

PUT [https://api.dynamicore.io/private/products/types]

Authorizations:
main_authapi_key
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "status": "success",
  • "message": {
    }
}

Create Products types

This endpoint is used to create products types.

HTTP Request

POST [https://api.dynamicore.io/private/products/types]

Parameters

Parameter Required Type Description Example
id Y Number Id of product type 17
name Y String Name of product type Factoraje Ej1
alias Y String Alias of product type Factoraje
company Y String Company of product type 22
template Y Object Template of product type [{"field": 36, "score": 1, "validate": {}, "displayname": "Valor Nominal"}, {"field": 37, "score": 2, "validate": {}, "displayname": "Garantia"}, {"field": 39, "score": 3, "validate": {}, "displayname": "Fecha de Creacion"}, {"field": 34, "score": 4, "validate": {}, "displayname": "CLABE"}, {"field": 28, "score": 5, "validate": {}, "displayname": "Contrato Firmado"}, {"field": 40, "score": 6, "validate": {}, "displayname": "Honorarios"}, {"field": 41, "score": 7, "validate": {}, "displayname": "Fecha de Vencimiento"}, {"field": 42, "score": 8, "validate": {}, "displayname": "Fecha de la Factura"}]
description Y String Description of product type Description product type
Authorizations:
main_authapi_key
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "status": "success",
  • "message": {
    }
}

Update Products types

This endpoint is used to update products types.

HTTP Request

PUT [https://api.dynamicore.io/private/products/types]

Parameters

Parameter Required Type Description Example
id Y Number Id of product type 17
name Y String Name of product type Factoraje Ej1
alias Y String Alias of product type Factoraje
company Y String Company of product type 22
template Y Object Template of product type [{"field": 36, "score": 1, "validate": {}, "displayname": "Valor Nominal"}, {"field": 37, "score": 2, "validate": {}, "displayname": "Garantia"}, {"field": 39, "score": 3, "validate": {}, "displayname": "Fecha de Creacion"}, {"field": 34, "score": 4, "validate": {}, "displayname": "CLABE"}, {"field": 28, "score": 5, "validate": {}, "displayname": "Contrato Firmado"}, {"field": 40, "score": 6, "validate": {}, "displayname": "Honorarios"}, {"field": 41, "score": 7, "validate": {}, "displayname": "Fecha de Vencimiento"}, {"field": 42, "score": 8, "validate": {}, "displayname": "Fecha de la Factura"}]
description Y String Description of product type Description product type
Authorizations:
main_authapi_key
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "status": "success",
  • "message": {
    }
}

Get Products Operations

This endpoint is used to get products operations.

HTTP Request

GET [https://api.dynamicore.io/private/products/typesprivate/products/operations?product=5]

Parameters

Parameter Required Type Description Example
product Y Number Id of product operation 5
Authorizations:
main_authapi_key
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "status": "success",
  • "message": {
    }
}

Create Products Operations

This endpoint is used to create products operations.

HTTP Request

POST [https://api.dynamicore.io/private/products/operations?product=5]

Parameters

Parameter Required Type Description Example
company Y Number Id of product operation 17
product Y Number Name of product operation 44
operation Y String Name of product operation "Movimiento"
Authorizations:
main_authapi_key
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "status": "success",
  • "message": {
    }
}

Delete Products operations

This endpoint is used to delete product operation.

HTTP Request

DELETE [https://api.dynamicore.io/private/products/operations?product=5]

Parameters

Parameter Required Type Description Example
id Y Number ID Clients 1
Authorizations:
main_authapi_key
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "status": "success",
  • "message": {
    }
}

Diagrams

Flows

Get Flows

This endpoint is used to get flows.

HTTP Request

GET [https://api.dynamicore.io/private/diagrams/flows]

Authorizations:
main_authapi_key
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "status": "success",
  • "message": {
    }
}

Create Flows

This endpoint is used to create flows.

HTTP Request

POST [https://api.dynamicore.io/private/diagrams/flows]

Parameters

Parameter Required Type Description Example
id Y Number Id of flow 1
name Y String Name of flow Flow1
company Y Number Id company of flow 1
enabled Y boolean Activate Flow true
service Y Number Id of service 1
diagrams Y String Diagram CC077
Authorizations:
main_authapi_key
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "status": "success",
  • "message": {
    }
}

Update Flows

This endpoint is used to update flows.

HTTP Request

PUT [https://api.dynamicore.io/private/diagrams/flows]

Parameters

Parameter Required Type Description Example
id Y Number Id of flow 1
name Y String Name of flow Flow1
company Y Number Id company of flow 1
enabled Y boolean Activate Flow true
service Y Number Id of service 1
diagrams Y String Diagram CC077
Authorizations:
main_authapi_key
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "status": "success",
  • "message": {
    }
}

Get Flow Types

This endpoint is used to get flow types.

HTTP Request

GET [https://api.dynamicore.io/private/diagrams/flows_types]

Authorizations:
main_authapi_key
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "status": "success",
  • "message": {
    }
}

Nodes

Get Nodes

This endpoint is used to get nodes.

HTTP Request

GET [https://api.dynamicore.io/private/diagrams/nodes]

Authorizations:
main_authapi_key
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "status": "success",
  • "message": {
    }
}

Create Nodes

This endpoint is used to create nodes.

HTTP Request

POST [https://api.dynamicore.io/private/diagrams/nodes]

Parameters

Parameter Required Type Description Example
id Y Number Id of flow 1
icon Y String Name of flow Flow1
class Y Number Id company of flow 1
input_map Y boolean Activate Flow true
output_map Y Number Id of service 1
company Y String Diagram CC077
Authorizations:
main_authapi_key
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "status": "success",
  • "message": {
    }
}

Update Nodes

This endpoint is used to update nodes.

HTTP Request

PUT [https://api.dynamicore.io/private/diagrams/nodes]

Parameters

Parameter Required Type Description Example
id Y Number Id of flow 1
icon Y String Name of flow Flow1
class Y Number Id company of flow 1
input_map Y boolean Activate Flow true
output_map Y Number Id of service 1
company Y String Diagram CC077
Authorizations:
main_authapi_key
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "status": "success",
  • "message": {
    }
}

Class

Get Class

This endpoint is used to get class.

HTTP Request

GET [https://api.dynamicore.io/private/diagrams/class]

Authorizations:
main_authapi_key
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "status": "success",
  • "message": {
    }
}

Create Class

This endpoint is used to create class.

HTTP Request

POST [https://api.dynamicore.io/private/diagrams/class]

Parameters

Parameter Required Type Description Example
id Y Number Id of flow 1
name Y String Name of flow Flow1
jar Y Number Id company of flow 1
input Y boolean Activate Flow true
output Y Number Id of service 1
description Y String Diagram CC077
Authorizations:
main_authapi_key
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "status": "success",
  • "message": {
    }
}

Update Class

This endpoint is used to update class.

HTTP Request

PUT [https://api.dynamicore.io/private/diagrams/class]

Parameters

Parameter Required Type Description Example
id Y Number Id of flow 1
name Y String Name of flow Flow1
jar Y Number Id company of flow 1
input Y boolean Activate Flow true
output Y Number Id of service 1
description Y String Diagram CC077
Authorizations:
main_authapi_key
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "status": "success",
  • "message": {
    }
}

Logs

Get Diagrams Logs

This endpoint is used to get logs.

HTTP Request

GET [https://api.dynamicore.io/?action=/diagrams/logs]

Authorizations:
main_authapi_key
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "status": "success",
  • "message": {
    }
}

Create Diagrams Logs

This endpoint is used to create logs.

HTTP Request

POST [https://api.dynamicore.io/?action=/diagrams/logs]

Parameters

Parameter Required Type Description Example
data Y String Data of Log 1
flow Y Number Id of Flow 1
node Y String Node to add 1
uuid Y uuid Id to Log 670b9562-b30d-52d5-b827-655787665500
extras Y Object Extra config
Authorizations:
main_authapi_key
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "status": "success",
  • "message": {
    }
}

Notifications

Email

Send emails

This endpoint is used to sender emails.

HTTP Request

POST [https://api.dynamicore.io/sender/email/template]

Parameters

Parameter Required Type Description Example
name Y String Name 22-130102029298373
subject Y Object Subject {{subject}}
html Y String HTML code

Hola {{name}}

Se le ha enviado {{amount}} pesos a la cuenta CLABE: {{account}}.

text Y String Text of Message Hola {{name}} Se le ha enviado {{amount}} pesos a la cuenta CLABE: {{account}}.
Authorizations:
main_authapi_key
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "status": "success",
  • "message": {
    }
}