forge-joniko/ldc-crm-client
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
ldc-crm-client/docs/usages/client.md
Jérémy Munsch f36447854b
API V3 UPDATE 
This removes api authentication with token in favor of signature method.
Refactored code and clean up. It add more unit test plus code coverage
in test/coverage.

- Added   : mardown documentation.
- Changed : model Stats::getQuestionStats  to pass question as route parameter
- Changed : now requests need to have a signature generated with a private key (crm password) using hmac sha256 wrapping url, method and parameters
- Changed : now timestamp will timeout if request is slower than "timestampTimeout", this means crm will reject the request
- Changed : throw ValidationException s instead of TypeErrors
- Changed : timestamp has to be send in request with a DateTime format, it also has to a UTC value
- Fixed   : Change WPCRM dynamic session key, this could prevent spoofing session in some cases.
- Fixed   : closure validation
- Fixed   : model mutator not catching reflectionException
- Fixed   : really send json request using Guzzle internal lib methods.
- Removed : Api AUTH system with api token
- Removed : ApiError::needAuth
- Removed : composer vlucas/dotenv, .env file is not handled any more.
- Removed : LoginException
- Removed : memcached dependency
- Removed : need of memcached
- Removed : unused service provider
- Removed : WpCrm::forceLogin
- Removed : WpCrm::sendArcadiaMailDefault
- Removed : WpCrm::sendArcadiaMailGame
- Updated : PHPCS rules, phpcs fixes and refactored code
2021-12-31 17:00:55 +01:00

658 B
Raw Permalink Blame History

Normal usage

Back

Classes you can use are located in the \LDC\LDCCRM\Models namespace.

  • Answer : To provide an answers to a specific question.
  • Customer : To fetch, create, update, delete, authenticate, activate, opt in or opt out you customer.
  • Question : Used to fetch questions, unanswered question but also answered questions.
  • SingleOptin : Use this to create a single opt in. For people who might just want to subscribe to a newsletter.
  • Stats : Use this to fetch stats about questions or just general stats.

For more detailed info, you may refer to the Client API DOC