PHPackages                             tuaititecnologia/krayin-rest-api - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. tuaititecnologia/krayin-rest-api

ActiveLibrary[API Development](/categories/api)

tuaititecnologia/krayin-rest-api
================================

Community-maintained fork of krayin/rest-api: the Krayin CRM REST API modernized for Laravel 12, with fixes across lead, contact, activity, mail, product and settings endpoints, plus a full test suite and CI.

v3.2.0(yesterday)00MITPHP ^8.2

Since Jul 9Compare

[ Source](https://github.com/tuaititecnologia/krayin-rest-api)[ Packagist](https://packagist.org/packages/tuaititecnologia/krayin-rest-api)[ Docs](https://github.com/tuaititecnologia/krayin-rest-api)[ RSS](/packages/tuaititecnologia-krayin-rest-api/feed)WikiDiscussions Synced today

READMEChangelog (4)Dependencies (5)Versions (10)Used By (0)

Krayin REST API
===============

[](#krayin-rest-api)

[![tests](https://github.com/tuaititecnologia/krayin-rest-api/actions/workflows/tests.yml/badge.svg)](https://github.com/tuaititecnologia/krayin-rest-api/actions/workflows/tests.yml)[![integration](https://github.com/tuaititecnologia/krayin-rest-api/actions/workflows/integration.yml/badge.svg)](https://github.com/tuaititecnologia/krayin-rest-api/actions/workflows/integration.yml)[![Latest Version](https://camo.githubusercontent.com/a7788da403dc7583de7c8c9b733848fc9e96d2f7e86bbe2fcac1f6aa28d62d5e/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f7475616974697465636e6f6c6f6769612f6b726179696e2d726573742d6170692e737667)](https://packagist.org/packages/tuaititecnologia/krayin-rest-api)[![Total Downloads](https://camo.githubusercontent.com/8451cee566bb12d17e3f7201c94cd76160ec07faa31a2c875f7ef807cb37fa1c/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f7475616974697465636e6f6c6f6769612f6b726179696e2d726573742d6170692e737667)](https://packagist.org/packages/tuaititecnologia/krayin-rest-api)

Krayin REST API is a medium to use the features of the core Krayin System. By using Krayin REST API, you can integrate your application to serve the default content of Krayin.

> **This is a community-maintained fork of [`krayin/rest-api`](https://github.com/krayin/rest-api)** modernizing the package for **Laravel 12**, with fixes across dozens of endpoints, a test suite and CI so the project can be safely built on and evolved. It is published on Packagist as **`tuaititecnologia/krayin-rest-api`** and is a **drop-in replacement**: it keeps the original `Webkul\RestApi` namespace and declares `replace: krayin/rest-api`, so no application code changes are needed. See [Installation](#2-installation), [Usage](#3-usage), [Testing](#4-testing) and [CHANGELOG.md](CHANGELOG.md).

1. Requirements
---------------

[](#1-requirements)

- **Krayin**: v2.x (running on Laravel 12)
- **PHP**: v8.2 or higher
- **Laravel**: v12

2. Installation
---------------

[](#2-installation)

This fork is published on Packagist, so a single command installs it:

```
composer require tuaititecnologia/krayin-rest-api
```

Because the package declares `replace: krayin/rest-api` and keeps the original `Webkul\RestApi` namespace, it is a **drop-in replacement**: any project (or package) that expects `krayin/rest-api` is satisfied by this fork, and no application code changes are required. To track the development branch instead of a tagged release, require `dev-main`.

> **Migrating from the original `krayin/rest-api`?** Remove it first so the two don't conflict, then require the fork:
>
> ```
> composer remove krayin/rest-api
> composer require tuaititecnologia/krayin-rest-api
> ```

### Add the following options to your .env file

[](#add-the-following-options-to-your-env-file)

```
SANCTUM_STATEFUL_DOMAINS="${APP_URL}"
```

```
L5_SWAGGER_UI_PERSIST_AUTHORIZATION=true
```

### To configure the REST API with L5-Swagger documentation, run the following command

[](#to-configure-the-rest-api-with-l5-swagger-documentation-run-the-following-command)

```
php artisan krayin-rest-api:install
```

After executing the above command, you will see the API endpoint displayed in the shell.

### Alternatively, you can check the API documentation by visiting the following URL in your browser

[](#alternatively-you-can-check-the-api-documentation-by-visiting-the-following-url-in-your-browser)

```
http://localhost/api/documentation
```

This matches the `l5-swagger` `routes.api` value and the URL printed by the install command (`{APP_URL}/api/documentation`).

- You can check the [L5-Swagger](https://github.com/DarkaOnLine/L5-Swagger) guidelines too regarding the configuration the API documentation.

### Known gotchas on an existing Krayin install

[](#known-gotchas-on-an-existing-krayin-install)

- **`personal_access_tokens` missing `expires_at`** — Sanctum 4.x reads/writes an `expires_at` column that didn't exist in the older Sanctum 2.x migration. Installs upgraded from Krayin's original 2.1.x scaffold are missing it, which breaks token issuance/validation. This package ships a migration that backfills the column automatically (a no-op if it's already there) — just run `php artisan migrate` after requiring the package.
- **Guest API requests must not redirect to `login`** — Laravel's `Authenticate`middleware can be configured (by the host app, or by a callback registered via `Authenticate::redirectUsing()`) to redirect unauthenticated users to a named `login` route. Krayin's admin panel has no such route reachable from the API guard, so this fork registers its own `redirectUsing()` callback that always returns `null` for any `api/*` request — guests get a clean JSON `401` instead of a `Route [login] not defined` crash. This is registered automatically in `RestApiServiceProvider::boot()`; no action needed on your end.

3. Usage
--------

[](#3-usage)

The API is authenticated with [Laravel Sanctum](https://laravel.com/docs/sanctum) bearer tokens.

### Get a token

[](#get-a-token)

```
curl -X POST {APP_URL}/api/v1/login \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"email":"admin@example.com","password":"secret","device_name":"my-app"}'
```

The response contains the authenticated user and a `token`. Send it as a bearer token on every subsequent request:

```
curl {APP_URL}/api/v1/leads \
  -H "Accept: application/json" \
  -H "Authorization: Bearer "
```

> Always send `Accept: application/json` so errors come back as JSON (`401` unauthenticated, `404` not found, `422` validation) rather than an HTML page.

### Some endpoints

[](#some-endpoints)

MethodPathDescription`POST``/api/v1/login`Authenticate; returns a bearer token`GET` / `POST``/api/v1/leads`List / create leads`GET` / `PUT` / `DELETE``/api/v1/leads/{id}`Show / update / delete a lead`GET` / `POST``/api/v1/contacts/persons`List / create persons`GET` / `POST``/api/v1/contacts/organizations`List / create organizationsThe full, always-current list — with request/response schemas — lives in the Swagger UI at `{APP_URL}/api/documentation`.

4. Testing
----------

[](#4-testing)

This package ships a fast, self-contained test suite built on [Orchestra Testbench](https://packages.tools/testbench). It boots the package inside a minimal Laravel 12 app — **no full Krayin CRM or database is required** — and verifies the surface the package owns and that the Laravel 12 upgrade touched: service-provider wiring, route registration, the `sanctum.admin` middleware, the custom exception handler's JSON contract, the OpenAPI attribute docs, the mass-action form requests, and the API resource transformers.

### Running the tests

[](#running-the-tests)

```
composer install        # pull dev dependencies (Testbench, PHPUnit)
composer test           # run the whole suite
```

Useful variations:

```
vendor/bin/phpunit --testsuite Unit          # only the Unit suite
vendor/bin/phpunit --testsuite Feature       # only the Feature suite
vendor/bin/phpunit --filter test_valid_payload_passes   # a single test
composer test-coverage                       # text coverage report (needs Xdebug/PCOV)
```

### Layout & philosophy

[](#layout--philosophy)

- `tests/Unit/` — pure classes exercised in isolation (form requests, resource transformers, the install command's metadata).
- `tests/Feature/` — the package booted in a container: provider wiring, route table, middleware, exception rendering, and Swagger generation.
- `tests/Integration/` — **black-box HTTP tests against a REAL running Krayin** (see below): the actual `api/v1/*` endpoints driven with a Sanctum token, through real controllers, repositories and Krayin attribute validation.
- `tests/TestCase.php` — the shared Testbench base; it registers only `RestApiServiceProvider` + Sanctum, keeping the Unit/Feature suites portable and CI-friendly.

Because the Unit/Feature tests never dispatch to controllers that depend on Krayin domain packages, they run anywhere in seconds.

### Integration tests (against a live Krayin)

[](#integration-tests-against-a-live-krayin)

The `Integration` suite covers what a package-only harness cannot: the plugin actually working on top of the CRM — login, real CRUD over leads / persons / organizations, and the error contracts this fork hardened (401 for guests, 404 for missing ids, 422 for invalid input, graceful mass-destroy). It is **inert unless pointed at an instance**, so the default run stays green without a CRM:

```
KRAYIN_BASE_URL=https://your-krayin.example.com \
KRAYIN_API_EMAIL=admin@example.com \
KRAYIN_API_PASSWORD=secret \
  composer test-integration
```

With `KRAYIN_BASE_URL` unset, every integration test self-skips. Tests are self-cleaning (records they create are deleted on teardown).

CI runs the Unit/Feature suite on PHP 8.2, 8.3 and 8.4 (`.github/workflows/tests.yml`), and a separate job (`.github/workflows/integration.yml`) provisions a throwaway Krayin, installs this plugin on top of it and runs the Integration suite end-to-end.

###  Health Score

41

—

FairBetter than 87% of packages

Maintenance100

Actively maintained with recent releases

Popularity0

Limited adoption so far

Community2

Small or concentrated contributor base

Maturity52

Maturing project, gaining track record

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~4 days

Total

4

Last Release

1d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/1b43b5f965507e1afea8f0e57c519499227c16967d8499b18d851e3920d731db?d=identicon)[tuaititecnologia](/maintainers/tuaititecnologia)

---

Tags

apilaravelsanctumcrmREST APIkrayinwebkul

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/tuaititecnologia-krayin-rest-api/health.svg)

```
[![Health](https://phpackages.com/badges/tuaititecnologia-krayin-rest-api/health.svg)](https://phpackages.com/packages/tuaititecnologia-krayin-rest-api)
```

###  Alternatives

[hasinhayder/tyro

Tyro - The ultimate Authentication, Authorization, and Role & Privilege Management solution for Laravel 12 & 13

6765.1k6](/packages/hasinhayder-tyro)[rupadana/filament-api-service

A simple api service for supporting filamentphp

210120.6k7](/packages/rupadana-filament-api-service)[gdebrauwer/laravel-hateoas

Expose the authorization logic of your REST API using HATEOAS links on your Laravel API resources

174101.9k](/packages/gdebrauwer-laravel-hateoas)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)