rerout 0.5.0

Official Dart SDK for the Rerout branded-link API.

rerout

Official Dart SDK for the Rerout branded-link API.

dependencies:
  rerout: ^0.1.0

Requires Dart ^3.9.0.

Usage

import 'package:rerout/rerout.dart';

final rerout = Rerout.initialize(apiKey: 'rrk_...');

final result = await rerout.links.create(
  const CreateLinkRequest(
    targetUrl: 'https://example.com/q4-sale',
    domainHostname: 'go.brand.com',
    code: 'q4',
  ),
);

switch (result) {
  case Success(:final data):
    print('Short URL: ${data.shortUrl}');
  case Error(:final error):
    print('Failed: ${error.message}');
}

Every call returns a Result<T> — either Success<T>(data) or Error<T>(ReroutException). No thrown exceptions in normal control flow.

API

Construction

Rerout.initialize(
  apiKey: 'rrk_...',                       // required
  baseUrl: 'https://api.rerout.co',        // optional
  dio: customDio,                          // optional — bring your own Dio
);

Links

rerout.links.create(CreateLinkRequest(...));
rerout.links.list(cursor: 0, limit: 50);
rerout.links.get('q4');
rerout.links.update('q4', UpdateLinkRequest(isActive: false));
rerout.links.delete('q4');
rerout.links.stats('q4', days: 30);

Project

rerout.project.stats(days: 7);
rerout.project.me();

QR codes

final url = rerout.qr.url(
  'q4',
  options: const QrOptions(size: 12, ecc: 'H'),
);
final svgResult = await rerout.qr.svg('q4');

Webhook management

rerout.webhooks.create(CreateWebhookRequest(...));
rerout.webhooks.list();
rerout.webhooks.delete('whk_...');

Webhooks are managed against /v1/projects/me/webhooks using API-key auth. The signing secret returned by create is shown once — store it securely.

Tags

rerout.tags.list();                                            // each tag carries its live `linkCount`
rerout.tags.create(const CreateTagRequest(name: 'Spring 2026', color: 'teal'));
rerout.tags.update('tag_abc123', const UpdateTagRequest(color: 'red'));
rerout.tags.delete('tag_abc123');

Tags are managed against /v1/projects/me/tags using API-key auth. list returns a TagSummary per tag (a Tag plus linkCount); create/update return a plain Tag. color is optional on create — the server defaults it to teal. On update, omitted fields are left unchanged and an empty patch is rejected before any request is sent.

Webhook signatures

final ok = ReroutWebhookSignature.verify(
  rawBody: request.body,
  signatureHeader: request.headers['x-rerout-signature']!,
  secret: const String.fromEnvironment('REROUT_WEBHOOK_SECRET'),
);

Default 5-minute tolerance; pass toleranceSeconds: 0 to disable the time check.

Error handling

ReroutException carries:

• code — stable identifier (bad_target_url, rate_limited, not_found, …)
• statusCode — HTTP status, or 0 for network failures
• message — human-readable
• path, timestamp — when supplied by the API
• isServerError, isRateLimited — convenience flags

Synthetic codes used when the server gave no JSON body: network_error, timeout, unexpected_response, unauthorized, forbidden, not_found, rate_limited, server_error, client_error.

Local development

dart pub get
dart analyze
dart test

License

MIT — see LICENSE.