mirror of
https://github.com/invoiceninja/invoiceninja.git
synced 2025-05-24 02:14:21 -04:00
Change from .dev to .test
This commit is contained in:
parent
a77e594da0
commit
854d2ee955
@ -48,7 +48,7 @@ API_SECRET=password
|
||||
|
||||
#GOOGLE_CLIENT_ID=
|
||||
#GOOGLE_CLIENT_SECRET=
|
||||
#GOOGLE_OAUTH_REDIRECT=http://ninja.dev/auth/google
|
||||
#GOOGLE_OAUTH_REDIRECT=http://ninja.test/auth/google
|
||||
|
||||
GOOGLE_MAPS_ENABLED=true
|
||||
#GOOGLE_MAPS_API_KEY=
|
||||
|
@ -1,6 +1,6 @@
|
||||
APP_ENV=development
|
||||
APP_DEBUG=false
|
||||
APP_URL=http://ninja.dev
|
||||
APP_URL=http://ninja.test
|
||||
APP_KEY=SomeRandomStringSomeRandomString
|
||||
APP_CIPHER=AES-256-CBC
|
||||
APP_LOCALE=en
|
||||
|
@ -18,7 +18,7 @@ use Utils;
|
||||
/**
|
||||
* @SWG\Swagger(
|
||||
* schemes={"http","https"},
|
||||
* host="ninja.dev",
|
||||
* host="ninja.test",
|
||||
* basePath="/api/v1",
|
||||
* produces={"application/json"},
|
||||
* @SWG\Info(
|
||||
|
@ -96,7 +96,7 @@ class Utils
|
||||
|
||||
public static function requireHTTPS()
|
||||
{
|
||||
if (in_array(Request::root(), ['http://ninja.dev', 'http://ninja.dev:8000', 'http://www.ninja.test'])) {
|
||||
if (in_array(Request::root(), ['http://www.ninja.test', 'http://www.ninja.test:8000'])) {
|
||||
return false;
|
||||
}
|
||||
|
||||
|
28
docs/api.rst
28
docs/api.rst
@ -10,7 +10,7 @@ To access the API you first need to create a token using the "API Tokens” page
|
||||
- **PHP SDK**: https://github.com/invoiceninja/sdk-php
|
||||
- **Zend Framework**: https://github.com/alexz707/InvoiceNinjaModule
|
||||
|
||||
.. NOTE:: Replace ninja.dev with https://app.invoiceninja.com to access a hosted account.
|
||||
.. NOTE:: Replace ninja.test with https://app.invoiceninja.com to access a hosted account.
|
||||
|
||||
Reading Data
|
||||
""""""""""""
|
||||
@ -19,39 +19,39 @@ Here’s an example of reading the list of clients using cURL from the command l
|
||||
|
||||
.. code-block:: shell
|
||||
|
||||
curl -X GET ninja.dev/api/v1/clients -H "X-Ninja-Token: TOKEN"
|
||||
curl -X GET ninja.test/api/v1/clients -H "X-Ninja-Token: TOKEN"
|
||||
|
||||
For invoices, quotes, tasks and payments simply change the object type.
|
||||
|
||||
.. code-block:: shell
|
||||
|
||||
curl -X GET ninja.dev/api/v1/invoices -H "X-Ninja-Token: TOKEN"
|
||||
curl -X GET ninja.test/api/v1/invoices -H "X-Ninja-Token: TOKEN"
|
||||
|
||||
You can search clients by their email address or id number and invoices by their invoice number.
|
||||
|
||||
.. code-block:: shell
|
||||
|
||||
curl -X GET ninja.dev/api/v1/clients?email=<value> -H "X-Ninja-Token: TOKEN"
|
||||
curl -X GET ninja.dev/api/v1/clients?id_number=<value> -H "X-Ninja-Token: TOKEN"
|
||||
curl -X GET ninja.dev/api/v1/invoices?invoice_number=<value> -H "X-Ninja-Token: TOKEN"
|
||||
curl -X GET ninja.test/api/v1/clients?email=<value> -H "X-Ninja-Token: TOKEN"
|
||||
curl -X GET ninja.test/api/v1/clients?id_number=<value> -H "X-Ninja-Token: TOKEN"
|
||||
curl -X GET ninja.test/api/v1/invoices?invoice_number=<value> -H "X-Ninja-Token: TOKEN"
|
||||
|
||||
To load a single record specify the Id in the URL.
|
||||
|
||||
.. code-block:: shell
|
||||
|
||||
curl -X GET ninja.dev/api/v1/invoices/1 -H "X-Ninja-Token: TOKEN"
|
||||
curl -X GET ninja.test/api/v1/invoices/1 -H "X-Ninja-Token: TOKEN"
|
||||
|
||||
You can specify additional relationships to load using the ``include`` parameter.
|
||||
|
||||
.. code-block:: shell
|
||||
|
||||
curl -X GET ninja.dev/api/v1/clients/1?include=invoices.invitations -H "X-Ninja-Token: TOKEN"
|
||||
curl -X GET ninja.test/api/v1/clients/1?include=invoices.invitations -H "X-Ninja-Token: TOKEN"
|
||||
|
||||
You can download a PDF using the following URL
|
||||
|
||||
.. code-block:: shell
|
||||
|
||||
curl -X GET ninja.dev/api/v1/download/1 -H "X-Ninja-Token: TOKEN"
|
||||
curl -X GET ninja.test/api/v1/download/1 -H "X-Ninja-Token: TOKEN"
|
||||
|
||||
Optional Settings
|
||||
"""""""""""""""""
|
||||
@ -74,14 +74,14 @@ Here’s an example of creating a client. Note that email address is a property
|
||||
|
||||
.. code-block:: shell
|
||||
|
||||
curl -X POST ninja.dev/api/v1/clients -H "Content-Type:application/json" \
|
||||
curl -X POST ninja.test/api/v1/clients -H "Content-Type:application/json" \
|
||||
-d '{"name":"Client","contact":{"email":"test@example.com"}}' -H "X-Ninja-Token: TOKEN"
|
||||
|
||||
You can also update a client by specifying a value for ‘id’. Next, here’s an example of creating an invoice.
|
||||
|
||||
.. code-block:: shell
|
||||
|
||||
curl -X POST ninja.dev/api/v1/invoices -H "Content-Type:application/json" \
|
||||
curl -X POST ninja.test/api/v1/invoices -H "Content-Type:application/json" \
|
||||
-d '{"client_id":"1", "invoice_items":[{"product_key": "ITEM", "notes":"Test", "cost":10, "qty":1}]}' \
|
||||
-H "X-Ninja-Token: TOKEN"
|
||||
|
||||
@ -104,7 +104,7 @@ Updating Data
|
||||
|
||||
.. code-block:: shell
|
||||
|
||||
curl -X PUT ninja.dev/api/v1/clients/1 -H "Content-Type:application/json" \
|
||||
curl -X PUT ninja.test/api/v1/clients/1 -H "Content-Type:application/json" \
|
||||
-d '{"name":"test", "contacts":[{"id": 1, "first_name": "test"}]}' \
|
||||
-H "X-Ninja-Token: TOKEN"
|
||||
|
||||
@ -112,7 +112,7 @@ You can archive, delete or restore an entity by setting ``action`` in the reques
|
||||
|
||||
.. code-block:: shell
|
||||
|
||||
curl -X PUT ninja.dev/api/v1/invoices/1?action=archive \
|
||||
curl -X PUT ninja.test/api/v1/invoices/1?action=archive \
|
||||
-H "X-Ninja-Token: TOKEN"
|
||||
|
||||
.. TIP:: For invoices use `mark_sent` to manually mark the invoice as sent
|
||||
@ -124,5 +124,5 @@ To email an invoice use the email_invoice command passing the id of the invoice.
|
||||
|
||||
.. code-block:: shell
|
||||
|
||||
curl -X POST ninja.dev/api/v1/email_invoice -d '{"id":1}' \
|
||||
curl -X POST ninja.test/api/v1/email_invoice -d '{"id":1}' \
|
||||
-H "Content-Type:application/json" -H "X-Ninja-Token: TOKEN"
|
||||
|
@ -44,7 +44,7 @@ Create an application in either Google, Facebook, GitHub or LinkedIn and then se
|
||||
|
||||
GOOGLE_CLIENT_ID=
|
||||
GOOGLE_CLIENT_SECRET=
|
||||
GOOGLE_OAUTH_REDIRECT=http://ninja.dev/auth/google
|
||||
GOOGLE_OAUTH_REDIRECT=http://ninja.test/auth/google
|
||||
|
||||
PhantomJS
|
||||
"""""""""
|
||||
|
@ -9,7 +9,7 @@ modules:
|
||||
enabled:
|
||||
- \Helper\Functional
|
||||
- PhpBrowser:
|
||||
url: 'http://ninja.dev:8000'
|
||||
url: 'http://ninja.test:8000'
|
||||
curl:
|
||||
CURLOPT_RETURNTRANSFER: true
|
||||
- Laravel5:
|
||||
|
Loading…
x
Reference in New Issue
Block a user