Skip to main content
MicroWork Cloud is a Brazilian ERP for vehicle dealerships and workshops, covering sales, stock, workshop orders, parts, CRM and finance. This connector brings MicroWork data into your Nekt Catalog through MicroWork’s report API. MicroWork works differently from most connectors, and it is worth understanding before you start. It publishes no per-entity endpoints — there is no “sales” endpoint, no “customers” endpoint. Instead, it exposes a single integration endpoint that runs a report layout you save inside MicroWork Cloud. You choose the report, the filters and the columns; MicroWork then gives you a request body that reproduces exactly that report. So in this connector you decide what the streams are. Each report layout you configure becomes one table in your Catalog, with the columns you left on that layout.

​
Before you start

You need two things from MicroWork:
  1. An API credential. Ask your MicroWork representative — it is not self-service. One credential covers every company in your organisation and gives access to all of your MicroWork Cloud data, so treat it as a password.
  2. At least one saved report layout, prepared as described below.

​
Preparing a report in MicroWork Cloud

1

Choose the report

Open the report that holds the data you want — for example Relatórios » Veículo » Venda de Veículo.
2

Process it

Set the filters, pick a period and click Processar.
3

Configure the columns

The processed table shows the available columns. Remove the ones you do not need and add the ones you do — the columns left here are exactly the columns the connector will bring into Nekt.
4

Save the layout

Save it under Meus Leiautes with a name of your choice.
5

Set the filters and companies

Define the filters for this layout, including which companies (Empresas Ativas) it covers. The period can be left as-is — the connector can move it on every run.
6

Copy the request body

Process the report once more, then click the </> button at the right of the table — Parâmetros para MicroWork APIs. Copy the request body it shows, from the opening brace to the closing brace, braces included.

​
Configuring MicroWork as a Source

In the Sources tab, click the “Add source” button in the top-right corner, then select MicroWork from the list of connectors. Click Next and add your access details.

​
1. Add account access

The following configuration fields are available:
  • API credential: The integration credential MicroWork issued for your organisation. It is sent as an Authorization: Bearer header.
  • Reports: One entry per report layout you want to sync. Each entry has:
    • Report name: The name of the table this report becomes in your Catalog. Use letters, numbers and underscores, for example venda_de_veiculo.
    • Request body: The text you copied from the report’s </> button.
    • Key columns (optional): Columns of this report that identify a row, for example chassi. When you fill this in, re-reading the same period updates rows instead of duplicating them. Leave it empty and the connector keys each row on a hash of the row’s own content.
    • Date column (optional): The column of this report that carries the row’s date, for example datamovimentacao.
    • Start date filter name and End date filter name (optional): The names of the two filters that bound this report’s period, written exactly as they appear inside the filtros text of the request body you pasted.
  • API URL (advanced): Root URL of your MicroWork Cloud instance. Only change it if MicroWork gave your organisation a dedicated address.
  • Start date (advanced): The earliest date to read on the first run, for reports that name their date filters.
  • Requests per minute (advanced): Maximum number of requests per minute the connector sends. Defaults to 10.
After configuring access, click Next.

​
2. Select streams

Choose which of your configured reports you want to sync. Each report appears here under the name you gave it. Select the streams and click Next.

​
3. Configure data streams

Customize how data should appear in your Catalog, including layer, table naming, and sync type.
  • Layer: Select the destination layer where extracted tables will be created.
  • Table name: Use the suggested name or customize it. You can also apply a prefix to all tables.
  • Sync Type: Choose between INCREMENTAL and FULL_TABLE.
A report supports INCREMENTAL only when you filled in all three of Date column, Start date filter name and End date filter name. Without them the connector has no way to move the report’s period, so it re-reads the period pasted in the request body on every run.
When you’re done, click Next.

​
4. Configure data source

Add a clear description for this source so your team can identify it easily. To define your Trigger, choose how often data should be extracted (for example, daily, weekly, or at fixed times). Optionally, configure additional settings:
  • Delta Log Retention, which controls how long old table states are kept. Learn more here.
  • Additional Full Sync, to periodically complement incremental runs with a complete refresh.
When you are ready, click Next to finalize setup.

​
5. Check your new source

You can view your new source on the Sources page. If needed, trigger a run manually from the source actions.
To see data in the Catalog, at least one source run must complete successfully.

​
Setting up incremental sync

The period of a MicroWork report lives inside the filtros text of the request body, as a pair of filters. Their names are different in every report — the vehicle sales report calls them Periododamovimentacaoinicial and Periododamovimentacaofinal, while a CRM report may call them DataCriacaoInicial and DataCriacaoFinal. Because of that the connector cannot guess them, and you name them yourself. To find them, look at the filtros part of the body you pasted. It is a list of Name=Value pairs separated by semicolons, and the two that carry your dates are the ones you want:
Here you would fill in Periododamovimentacaoinicial and Periododamovimentacaofinal, plus the report column that holds each row’s date as the Date column. With all three filled in, every run asks MicroWork only for the period since the last successful run, and writes the dates back in the same format your report already used. Every other filter you configured is left untouched.

​
Good to know

  • You choose the columns, in MicroWork. A table in Nekt has exactly the columns the saved layout returns. If you add a column to the layout later, reload the source’s streams in Nekt so the new column is picked up.
  • Every report column arrives as text. A MicroWork report is a rendered table: the same column can come back formatted differently depending on how the layout is built, and MicroWork documents no types. Rather than guess — and risk a column changing type between runs — the connector stores every report column as text. Cast what you need in a Query or Notebook. The only exception is the Date column you name, which is converted to a UTC timestamp.
  • Four extra columns are added to every table. _mw_report (which report the row came from), _mw_extracted_at (when it was read), _mw_row_id (a hash of the row, used as the key when you name no key columns) and _mw_row (the whole row as JSON text, so a column you add to the layout later is still recoverable from past runs).
  • One call per report, per run. MicroWork returns a whole report in a single response — there is no paging. A report with a very wide period is one large response, so prefer narrow periods and incremental sync over re-reading years on every run.
  • MicroWork limits heavy usage. The vendor publishes no quota but states it monitors its servers and may limit or block the number of daily queries it considers excessive. That is why the connector defaults to 10 requests per minute. Keep the number of reports and the sync frequency to what you actually need.
  • The credential is organisation-wide. Which companies a report covers is decided by the layout’s Empresas Ativas filter, not by the credential.
  • A report that returns no rows teaches the connector nothing. If a report comes back empty when the source is set up, its table is created with only the four connector columns. Widen the report’s period in MicroWork so it returns at least one row, then reload the source’s streams.

​
Streams and Fields

This connector has no fixed list of streams. Each report layout you configure becomes one stream, named by you, and its fields are the columns of that report.
These four columns are present in every table this connector creates, alongside the report’s own columns.
An example of what a report stream looks like. These are the columns of the Relatórios » Veículo » Venda de Veículo layout used in MicroWork’s own integration manual — your reports will have whatever columns you put on them.